Re: Documenting functions that rely on namespace?

new topic     » goto parent     » topic index » view thread      » older message » newer message

Mike777 wrote:
> 
> 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 <a
> href="http://www.rapideuphoria.com/refman.htm">http://www.rapideuphoria.com/refman.htm</a>.
>  
> 
> 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
http://jeremy.cowgar.com

new topic     » goto parent     » topic index » view thread      » older message » newer message

Search



Quick Links

User menu

Not signed in.

Misc Menu