[nmglug] structured comments in C code for doc extraction
Mark Galassi
mark at galassi.org
Fri Nov 3 21:30:09 PST 2006
Amigos, when I write C code I have been using Michael Zucchi's
"gnome-doc.el" routines in emacs. This has elisp code that inserts
structured comments that look like this:
/**
* function_name:
* @param1:
* @param2:
*
* _
*
* Return Value:
**/
int function_name(char *param1, int param2)
{
...
which can then be processed into docbook, texinfo, straight html and
so forth by a set of scripts that are in the gnome library utilities.
This works well, but is kind of old at this point, so I was wondering
if in the intervening years the C community has come up with a widely
adopted way of doing structured API comments, the way C++ dudes use
doxygen.
Anyone have any perspective or favorits?
More information about the nmglug
mailing list