OpenEuphoria

Re: Documenting functions that rely on namespace?

• Posted by Mike777 <anon4321 at gm?i?.com> Apr 25, 2008
• 634 views

Jeremy Cowgar wrote:
> 
> Ok, maybe they do not rely upon, but are easier understood by namespace.
> Here's
> what I am speaking of...
> 
> }}}
<eucode>
> include datetime.e as d
> include map.e as m
> 
> datetime d1
> map m1
> 
> d1 = d:new(2008, 10, 20, 12, 30, 0)
> m1 = m:new()
> </eucode>
{{{

> 
> So, we have 2 new functions. How do I go about documenting that?

EU has a fairly well defined method of documentation at the moment.  There are
essentially two distinct placements.  The first is the documentation that can be
found at http://www.rapideuphoria.com/refman.htm.

Part I is the Core Language
Part II are the built in Library routines
(http://www.rapideuphoria.com/library.htm)

Other libraries have their own documentation in a specific format that I assume
you are familiar with.  See win32Lib for example.

Why wouldn't the standard library not just be documented as win32Lib is?

Mike