Re: [Doxygen-users] one document paragraph for N types set by typedef struct?
Brought to you by:
dimitri
From: mathog <ma...@ca...> - 2013-11-25 20:54:15
|
On 23-Nov-2013 02:35, Albert wrote: > David, > > Please have a look at DISTRIBUTE_GROUP_DOC set to yes and the grouping > possibilities by using @{ and @} > The following looks like to work for me: > /// @{ > /** Description blah blah > */ > typedef struct names { > SomeStructName field; //!< Description of field > } name1, name2, name3, namen; > /// @} > > > Note: that I had to make a named struct of it as well otherwise name1 > would > be used as type name and not as variable.\ Not working for me. I have: /** \defgroup Common_macros Common Macros @{ */ // many many #defines /** @} */ // many many typedef struct's but no \defgroup /** Draw figure @{ */ typedef struct foobar { U_EMR emr; //!< U_EMR U_RECTL rclBounds; //!< bounding rectangle in device units U_NUM_POINTL cptl; //!< Number of points to draw U_POINTL aptl[1]; //!< array of points } U_EMRPOLYBEZIER, U_EMRPOLYGON, U_EMRPOLYLINE, U_EMRPOLYBEZIERTO, U_EMRPOLYLINETO; /** @} */ When run with DISTRIBUTE_GROUP_DOC=yes it does not document the 2nd or later names, and emits this odd set of errors: emf.h:1980: warning: Member U_EMRPOLYGON (typedef) of group Common_macros is not documented. emf.h:1981: warning: Member U_EMRPOLYLINE (typedef) of group Common_macros is not documented. emf.h:1982: warning: Member U_EMRPOLYBEZIERTO (typedef) of group Common_macros is not documented. emf.h:1983: warning: Member U_EMRPOLYLINETO (typedef) of group Common_macros is not documented. This is not part of Common_macros, that seems to be firmly terminated, but not for doxygen, apparently. Putting \defgroup foobar in at the top changes it to emf.h:1980: warning: Member U_EMRPOLYGON (typedef) of group foobar is not documented. but does not resolve the issue. Thanks, David Mathog ma...@ca... Manager, Sequence Analysis Facility, Biology Division, Caltech |