Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to reference to member group in doxygen

I have found how to give a group of class members a name:

/**\{
\name Foo
*/
 members
/**
\}*/

, but how do I reference to Foo from other class members?

like image 708
user877329 Avatar asked Apr 17 '13 11:04

user877329


People also ask

How do I show code in doxygen?

You can put example source code in a special path defined in the doxygen config under EXAMPLE_PATH , and then insert examples with the @example tag. Doxygen will then generate an extra page containing the source of the example. It will also set a link to it from the class documentation containing the example tag.

What is a doxygen tag?

Doxytag is a small command line based utility. It can generate tag files. These tag files can be used with doxygen to generate references to external documentation (i.e. documentation not contained in the input files that are used by doxygen).

Are doxygen commands case sensitive?

It is parsed by doxygen . The file may contain tabs and newlines for formatting purposes. The statements in the file are case-sensitive. Comments may be placed anywhere within the file (except within quotes). Comments begin with the # character and end at the end of the line.


1 Answers

/** \{
\anchor Foo
\name   Foo
*/
members
/** \} */

The anchor allows you to refer to the group from elsewhere using

/// \ref Foo
like image 158
Eric Miller Avatar answered Nov 05 '22 11:11

Eric Miller