Re: [Doxygen-users] Grouping Defines

[Dimitri V. H. <do...@gm...>]

On 21 apr 2008, at 16:04, Arnaud RICHARD wrote:

> Dear doxygen users,
>
> In C, I have a list of #define that is to be considered as a coherent
> group used by a function.
>
> I would like to
> 1) Identify this group with a subtitle in the section "Defines" of the
> file documentation.
> 2) Refers to this group with an hyperlink from the documentation of a
> function.
>
> It seems incredibly simple, but I'm struggling to have the 2 features
> together !
>
> First, if I use "@name My group purpose",
> the group is well isolated in doc but I can't refer to it.
>
> Secondly, if I use "@defgroup Group1 My group purpose",
> the link "@ref Group1" works nicely (even replacing automatically  
> Group1
> by the title which is what I wanted),
> a separate documentation page is created, which is not my goal but  
> why not,
> but in the file documentation, the group does not appear as such in  
> the
> section "Defines" !
>
> Can someone give a trick ?

For 1) using @anchor should work. Here's an example:

/** @file
  *  @see \ref refme "numbers" for details
  */

/** @name Numbers
  *  Some info about this group of macros
  *  @anchor refme @{
  */
#define ONE 1
#define TWO 2
/** @} */

Regards,
   Dimitri