[Doxygen-users] Function grouping problem
Brought to you by:
dimitri
|
From: Marc B. <be...@ro...> - 2001-06-06 18:44:30
|
Sorry if this has been discussed before. I did a search on the archive
and could not find anything.
The problem: if I have a project that defines modules, and within a
class I define a group of functions without a preceding comment defining
a group name (the @name command), like so:
/*! \defgroup Groupname Collection Classes
* This set of classes supports various sorts of collections.
*/
class SomeClass {
...
//@{
someFunc1();
//!< Documentation for this group of functions.
someFunc2();
someFunc3();
//@}
...
}
I find that the function group appears on and is documented on some
module page (it is hard to predict which one), not on the class
description page. If you add a group naming comment
/*! @name Accessor Functions */
//@{
someFunc1();
//!< Documentation for this group of functions.
someFunc2();
someFunc3();
//@}
the function group appears on and is documented on the class description
page as you would like. This means, unless I am doing something wrong,
that I must define a group name if I want to use this feature. I would
rather have the option of not defining a group name if that is possible.
Am I doing anything wrong? If so, what? If not, are there any known
workarounds? (The best one I know is to define an empty group naming
comment
/*! @name */
which forces the correct behavior with only the price of somewhat odd
spacing because of the empty line for the undefined group name.
Cheers,
Marc Betz
|