RE: [Doxygen-users] Re: Documenting enums of an IDL file

[Glenn M. <gle...@vo...>]

> -----Original Message-----
> From: Don McClimans [mailto:dmc...@in...]
> Sent: Tuesday, February 19, 2002 5:36 PM
> To: dox...@li...
> Cc: Glenn Maxey
> Subject: RE: [Doxygen-users] Re: Documenting enums of an IDL file
>=20
>=20
> [Don]
> Well, we already use groups to separate the "methods" from=20
> the "properties".
> You can't nest groups, unfortunately, so we can't then group=20
> each property get and put function.

Actually, you can nest groups. (1) You just can't specify the top level =
and a lower level at the same time on a given code item. (2) The code =
item will be documented in one place, but you could get the brief =
summaries in multiple places.

/** @defgroup class_name **/

/** @defgroup m_<class_name> Methods of <class_name>
    @ingroup class_name=20
 **/

/** @defgroup p_<class_name> Properties of <class_name>
    @ingroup class_name=20
 **/

/** @brief my code item
    @ingroup m_<class_name>
 **/
my code ....

/** @brief my code property
    @ingroup p_<class_name>
 **/
my code2 ...


Admittedly, your naming scheme could become involved, whereby each class =
would have a parent group as well as two nested groups.

I'm not sure if the following would work completely...

/** @defgroup all_methods **/
/** @defgroup all_properties **/
/** @defgroup class_name **/

/** @defgroup m_<class_name> Methods of <class_name>
    @ingroup class_name all_methods
 **/

/** @defgroup p_<class_name> Properties of <class_name>
    @ingroup class_name all_properties
 **/

/** @brief my code item
    @ingroup m_<class_name>
 **/
my code ....

/** @brief my code property
    @ingroup p_<class_name>
 **/
my code2 ...

> You can do things like this, but it's not really=20
> satisfactory, in my opinion at least.=20

I agree.

I have gotten nesting to work, but I haven't always gotten what I =
desired when more than one group was assigned to @ingroup (as I show =
above).

Glenn