First, I've never used doxygen. It just sounds like a gook way to understand the code.
Everything you need to know is there http://www.stack.nl/~dimitri/doxygen/manual.html The main things to know for writing well formated comments are : doxygen recognize commands, they starts with a '\' ou a '@'. for documenting a code item there can be a brief and detailed description. The laste ones are recognized with /** my detailed description */ or /*! blah */. For more information about basic documenting a code item see : http://www.stack.nl/~dimitri/doxygen/docblocks.html for example the following pattern could be placed before every function : /// Print "hello world" /** Use a complicated formula to compute the code of each char to print "hello world" * @param n number of time to print the string * @return the number of succefully computed char */ int hello (int n); There are a lot of commandes to use, they are listed here http://www.stack.nl/~dimitri/doxygen/commands.html But since I've never used doxygen I don't know which ones are useful. Celelibi 2007/10/29, Alan Grimes <[EMAIL PROTECTED]>: > Celelibi wrote: > > Hello, > > > > I'm interested in contributing to ktechlab developpement. But there > > are many files and a lot of functions, it's a bit hard to have a > > global understanding of ktechlab. I think well documenting the code > > would be a good start point. > > > > What do you think about that ? > > Good idea, issue is that I don't know how to use Doxygen... It seems to > require the inclusion of specially formatted tags in the code however I > don't know how to write them. If you could do the research for me, a > printable doxygen cheat-sheet would be ideal. =P > > > -- > Buy Ron Paul's Money! =) > http://www.libertydollar.org/ld/ronpauldollar > Soundest investment on the planet! > > ------------------------------------------------------------------------- > This SF.net email is sponsored by: Splunk Inc. > Still grepping through log files to find problems? Stop. > Now Search log events and configuration files using AJAX and a browser. > Download your FREE copy of Splunk now >> http://get.splunk.com/ > _______________________________________________ > Ktechlab-devel mailing list > Ktechlab-devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/ktechlab-devel > -- -----BEGIN GEEK CODE BLOCK----- Version: 3.12 GS/M>O d-@>-- s: a--->? C++(+++)>$ UL++>++++$ P++(+)>++++$ L+++(++)>+++++$ E-?>++@ W+++>$ N?>++@ o?>+++++$ K->[EMAIL PROTECTED] !w>$ O? M- V? PS PE Y+(++)>+++@ PGP+@>+++ t?>+@ 5? X+()R->+@ !tv>$ b(-) DI? !D>[EMAIL PROTECTED] G>+++@ e+>+++++ h!>*$ r-- y>$ ------END GEEK CODE BLOCK------ ------------------------------------------------------------------------- This SF.net email is sponsored by: Splunk Inc. Still grepping through log files to find problems? Stop. Now Search log events and configuration files using AJAX and a browser. Download your FREE copy of Splunk now >> http://get.splunk.com/ _______________________________________________ Ktechlab-devel mailing list Ktechlab-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/ktechlab-devel
