Re: [Doxygen-users] reference to a named member group from mainpage

[Pete B. <br...@us...>]

Thanks Joe, Here is what I did:

In main...

 @section _constants Constants
  @ref grpRelations\n
  @ref grpStates\n

In a file with constants...

/** @defgroup grpStates States
 State constants.
*/
///@{
...
///@}


Pete Brunet
                                                                          
IBM Accessibility Architecture and Development
11501 Burnet Road, MS 9022E004, Austin, TX 78758
Voice: (512) 838-4594, TL 678-4594, Fax: (512) 838-9666
Ionosphere: WS4G




Paul Joireman <joi...@fn...> 
09/08/2006 09:44 AM
Please respond to
joi...@fn...


To
Pete Brunet/Austin/IBM@IBMUS
cc
dox...@li...
Subject
Re: [Doxygen-users] reference to a named member group from mainpage






Pete,

I think the best way to do this is to use module groups instead of member 
groups.  When you 
define a member group there is no group reference attribute included with 
the @name tab.  Thus there is no way to reference the member group with an 
@ref grpName elsewhere in the documentation.   You could hack up the HTML 
to place anchors where you want but that detracts from ease of generating 
the documentation.  Member groups also do not allow nesting which seems to 
be something you want here, but this is just a guess. 

Module groups would handle all of these things, requiring a grpName 
attribute which can be used anywhere in anywhere in the documentation. The 
groups can also be nested.   So your documentation might look something 
like:

/** @defgroup grpConstants Constants 
*/ 
///@{ 
    ....
///@}

/** @defgroup grpCharWeight Character Weights
    @ingroup grpConstants
 Constants for the CharWeight attribute 
*/ 
///@{ 
/** The font weight is not specified/known. */ 
const float IA2_CHARWEIGHT_DONTKNOW = 0; 
... more constants... 
///@}

/** @defgroup grpRelations Relations 
    @ingroup grpConstants
*/ 
///@{ 
    ....
///@{}


/** @defgroup grpStates States
    @ingroup grpConstants
*/ 
///@{ 
    ....
///@}


Your mainpage might look something like

/**
 @mainpage
...
<H3> Constants </H3>

- @ref grpCharWeight
- @ref grpRelations
- @ref grpStates

...

*/

The text for each group name will be included an automatically hyperlinked 
by doxygen. 

Paul

Pete Brunet wrote: 

In my main page I want to reference groups of constants in named member 
groups.  A typical group looks like this... 

/** @name Constants 
 Constants for the CharWeight attribute 
*/ 
///@{ 
/** The font weight is not specified/known. */ 
const float IA2_CHARWEIGHT_DONTKNOW = 0; 
... more constants... 
/// @} 

And want my main page to look like this in the browser 

Constants 

Character Weights 
Relations 
States 

with that text being hypertext linking to named member groups like the one 
shown above.  How do I tag the named member group and the mainpage? 

Thanks,
Pete Brunet
                                                                         
IBM Accessibility Architecture and Development
11501 Burnet Road, MS 9022E004, Austin, TX 78758
Voice: (512) 838-4594, TL 678-4594, Fax: (512) 838-9666
Ionosphere: WS4G


-------------------------------------------------------------------------
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job 
easier
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
 


_______________________________________________
Doxygen-users mailing list
Dox...@li...
https://lists.sourceforge.net/lists/listinfo/doxygen-users