[ANet-devel] Re: doxygen for low-level design
Status: Abandoned
Brought to you by:
benad
From: Chirag K. <ch...@ya...> - 2001-12-13 13:13:47
|
On Wed, Dec 12, 2001 at 10:29:32AM -0500, Benoit Nadeau wrote: | //! A normal member taking two arguments and returning an integer value. | /*! | \param a An integer argument. | \param s A constant character pointer. | \return The test results | \see Test(), ~Test(), testMeToo() and publicVar() | */ | int testMe(int a,const char *s); <snip> | Anyways, I "toyed" a bit with the code, and here's the result: | http://anet.sourceforge.net/doc.tar.gz | HTML starts in html/index.html | PDF is in latex/refman.pdf This is just great. If not the graphs and extensive documentation, I think, everybody can at least do the above: \param, \return and \see, if applicable, to their code. It shouldn't be much. In process of writing code for the fileI/O stuff, I've got lot of doubts but I'm saving it all up. I'll send in a huge mail soon, after I finish most of it or the mail gets very big. chyrag. -- Chirag Kantharia, chyrag.dhs.org/ |