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): /** short description of the function. * optional longer description of the function * @param arg1 description of arg1 * @param arg2 description of arg2 * @return description of return valus */ So I'd suggest when refactoring also moving to that syntax -- you could still use your generator, or optionally run doxygen on it. There are also groups (though I don't remember off the top of my head how that tag was). As a side note, doxygen also understands tags with leading \ instead of @ so that could also get used. I, however, prefer the latter. - Dominik
