[Doxygen-users] grouping patches

[Patrick O. <Pat...@pa...>]

Hi all,

here are patches for doxygen that enhance (or so I hope) the
grouping capabilities:

There are now three commands to define a group:
  \defgroup name title
  \addtogroup name [title]
  \weakgroup name [title]

\defgroup must be used exactly once for a group, so you should
provide a title. Without the title you will get a warning and
doxygen will use the name as title (this is the old behaviour).

/** \addtogroup name */ can be used to add documentation or
members to a group (as in 1.2.7), but the group is created if
it doesn't exist yet. You can provide the title later
with another block:
/**
 * \addgroup name title
 * documentation
 */

Setting different titles will trigger a warning without overwriting
the title once more.

\weakgroup is exactly the same as \addtogroup, but if a member
was put into such a group with \weakgroup name @{ @} and into
another group with \[def|addto]group @{ @}, then it will be
placed into the other group without issuing a warning.

Actually there is a four-level hierarchy for grouping with
(from strongest to weakest) \ingroup, \defgroup, \addtogroup,
\weakgroup. You will get warnings when putting members into
groups with commands of the same level, but only when you really
document this member. This will not trigger a warning and put
variable a into Group1:

/** \addtogroup Group1 */
/*@{*/
/** this is the real group */
extern int a;
/*@}*/

/** \addtogroup Group2 */
/*@{*/
extern int a;
/*@}*/

Member groups (i.e. grouping of struct/class members) works as
before.

I have attached the diff and an example that uses the new
features and also triggers some warnings on purpose.

Bye, Patrick
-- 
// pallas  GmbH  ............  Patrick Ohly  .............
   Hermuelheimer Str. 10       Software-Engineer
   D-50321 Bruehl, Germany     po...@pa...
   fax +49-(0)2232-1896-29     phone  +49-(0)2232-1896-30 
   http://www.pallas.com 
..........................................................