doxygen-users

[Doxygen-users] Function grouping problem

[Marc B. <be...@ro...>]

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

Re: [Doxygen-users] Function grouping problem

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

On Wed, Jun 06, 2001 at 11:44:10AM -0700, Marc Betz wrote:
> 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.

Which version of doxygen are you using? Some versions had this kind
of problem, but grouping was partly rewritten since then and the latest
version should work as expected.

Bye, Patrick Ohly
-- 
// 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 
..........................................................

Re: Re: [Doxygen-users] Function grouping problem

[Arkadiusz P. <wo...@so...>]

On Thu, Jun 07, 2001 at 08:58:43AM +0200, Patrick Ohly wrote:
> On Wed, Jun 06, 2001 at 11:44:10AM -0700, Marc Betz wrote:
> > 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.
> Which version of doxygen are you using? Some versions had this kind
> of problem, but grouping was partly rewritten since then and the latest
> version should work as expected.

I've noticed the same problem. But I'm sure that defining empty group is a
kind of religion, not the solve of the problem. Yes, I've tried it too, but
it stopped to work now for me... ;-). I haven't time to extract strict
simple example of code, but what I see: if you define some groups then not
every unnamed group is collected on module page. I think it can be every
group which is parsed _after_ any ,,\ingroup'' command (named too). I've
tried adding ,,\class'' command at ,,\ingroupped'' class comment, but it
works sometimes only (yes, it's voo-doo, I know, but it worked). I'm using
doxygen 1.2.7 version now (1.2.1 doesn't do this) - but didn't see anything
in v. 1.2.8 changelog about it.

I have another problem yet: tags doesn't work for me. Core suggests segfault
on an ,,empty'' object (sorry, I have no code now) with pointer 0x300000
(too even for me as a pointer). Gcc version incompatibility? I know that
it's buggy. But, again, 1.2.1 works... ;-) I debugged it for a while: object
_is_ initialized, but later variable changes... A kind of buffer overflow, I
think rather. Dimitri, I can ,,generate'' core if you need...

I've tested on two Linuxes: Slackware 7.1 and RedHat 6.0 - both the same
egcs (2.95-2 as I remember).