On Tue, Jan 13, 2009 at 5:39 PM, Dominik Riebeling <[email protected]> wrote: > On Tue, Jan 13, 2009 at 3:26 PM, Maurus Cuelenaere > <[email protected]> wrote: >> The way I see it how this should be done is something like: >> >>> /* >>> Description of function. [REQUIRED] >>> arg1: description of arg1 [OPTIONAL] >>> >>> arg2: description of arg2 [OPTIONAL] >>> returns: description of return value [OPTIONAL] >>> */ >>> int (*function)(int arg1, int arg2); > > That's pretty much like doxygen comments work, which would look like > this (given that the AUTOBRIEF option is turned on, otherwise you'd > need an additional @brief in the first line): >
Which begs the question why not just use doxygen to generate the documentation? -- Alex, homepage: http://www.bennee.com/~alex/ CV: http://www.bennee.com/~alex/cv.php
