[Doxygen-users] Documenting C structs
Brought to you by:
dimitri
|
From: Clayton C. <crc...@cs...> - 2001-07-24 21:35:42
|
What have folks found to be the best way of documenting C
structs? I was hoping that there'd be a command `@member' so that
structs could be documented like functions. For instance, we've got
this:
/**
* Function to init some data
* @param inFile ...
* @return ...
*/
int init_data( char *inFile )
and we can also use the `/*!<' syntax to document `inFile'
right where we define it. Anyway, it seems as this on location
documentation is only option when working with structs. I'd like
something like this:
/**
* @struct data
* @brief ...
* @member mins ...
* @member maxs ...
* @member means ...
* etc.
*/
typedef struct {
double mins, maxs, means, medians, sigs, totals;
} data;
Please chastise me if I'm way off base here. I've scanned the
docs, but not seen anything like what [I think] I'm talking about.
Thanks.
--pc
--
Clayton Carter crc...@cs...
"My mom says I'm the handsomest guy in school."
|