[Netnice-daemon] Re: netniced code documentation - doxygen

[Takashi O. <ta...@cs...>]

hi,

Sergei Matusevich wrote:
> 
> Taka,
> 
> Attached is a quick doxygen-generated documentation - please take a look.

hmm... okay. if you take the responsibility, it's okay with me. i say
responsibility, simply because once we migrate into another documentation
system, partial work would be hazardous, particularly, due to some dirty
tricks we have been using for cross-language documentation. once we started,
we have to finish.

anyway, i have several requests, which, i believe, are too reasonable to you.
they are to hide C++ implementation detail from users.

	- "File List" is unnecessary
	- Definition at line xx of file xxx.x is unnecessary
	- #include statement at the top of each class reference is unnecessary

please note that the document should look like a document that describes
JavaScript classes and objects, which is not a typical use of doxygen.
actually, we may keep two types of netniced-documents; for users and for
developers. the above requests apply just to the user documentation.
if time permits, i would be happy if you update under www/documents/doc,
accordingly.

anyway, please take your time for the migration, and please work at your
own pace, since it would be a big step for us. :-)


thanks,


-- taka