RE: [Doxygen-users] Documenting C structs

[Wagner, V. <VW...@se...>]

given that the differences between struct and class is minimal, what's wronw
with the way it documents them now?

-----Original Message-----
From: Clayton Carter [mailto:crc...@cs...]
Sent: Tuesday, 2001 July 24 17:36
To: dox...@li...
Subject: [Doxygen-users] Documenting C structs


	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."

_______________________________________________
Doxygen-users mailing list
Dox...@li...
http://lists.sourceforge.net/lists/listinfo/doxygen-users


This transmission may contain information that is privileged, confidential
and exempt from disclosure under applicable law.
If you are not the intended recipient, you are hereby notified that any
disclosure, copying, distribution, or use of the information contained
herein (including any reliance thereon) is STRICTLY PROHIBITED.
If you received this transmission in error, please immediately contact the
sender and destroy the material in its entirety, whether in electronic or
hard copy format.
Thank you