OpenEuphoria

Re: Documenting functions that rely on namespace?

• Posted by Jason Gade <jaygade at yahoo?c?m> Apr 25, 2008
• 622 views

Jeremy Cowgar wrote:
> 
> Mike777 wrote:
> > 
> > EU has a fairly well defined method of documentation at the moment.  There
> > are
> essentially two</font></i>
> > distinct placements.  The first is the documentation that can be
> found at <a
> href="http://www.rapideuphoria.com/refman.htm">http://www.rapideuphoria.com/refman.htm</a>.</font></i>
> >  
> > 
> > Part I is the Core Language
> > Part II are the built in Library routines (<a
> > href="http://www.rapideuphoria.com/library.htm">http://www.rapideuphoria.com/library.htm</a>)
> > 
> > Other libraries have their own documentation in a specific format that I
> > assume
> > you are familiar with.  See win32Lib for example.
> >
> 
> Yes, that is what I am speaking of. I have added much documentation there
> already.
> The problem is that if we use namespaces, we now have multiple functions by
> the exact same name, so far in this instance, new. So, listed in the
> Alphabetical
> listing would be 2 new() functions. Then internally when you use anchors for
> navigation, which "new" is one referring to? That's the problem. Not to
> mention,
> just looking pretty confusing with two new() functions listed back to back.
> 
> --
> Jeremy Cowgar
> <a href="http://jeremy.cowgar.com">http://jeremy.cowgar.com</a>

For functions and procedures that actually act like object methods on a data
type, list them as if they were methods. So "datetime" would have an entry
describing its fields and methods.

Under the alphabetical entry for "new" put "see datetime" etc. Of course, that
could get kind of unwieldy.

Maybe "datetime:new"?

--
A complex system that works is invariably found to have evolved from a simple
system that works.
--John Gall's 15th law of Systemantics.

"Premature optimization is the root of all evil in programming."
--C.A.R. Hoare

j.