24 Nov
2003
24 Nov
'03
5:06 p.m.
On Mon, 24 Nov 2003, Kees Cook wrote:
On Sat, Nov 22, 2003 at 12:37:58PM -0800, Bryce Harrington wrote:
/** my_function(arg1, arg2)
- This routine blah blah...
- On failure, the routine will yada yada...
*/ void my_function(int arg1, int arg2) ...
These comments will get picked up and parsed by Doxygen, and so will make the online documentation of the codebase useful.
How does doxygen parse those kinds of comments? Or rather, what format is required so that they'll get picked up correctly?
The two asterisks starting the comment are what clues it in that it's a comment. Technically the first line isn't needed since the function name and params automatically get picked up.
Bryce