How to refer to group in doxygen?

Member

by lottie , in category: Third Party Scripts , a month ago

How to refer to group in doxygen?

Facebook Twitter LinkedIn Telegram Whatsapp

1 answer

by herminia_bruen , a month ago

@lottie 

In order to refer to a group in Doxygen, you can use the defgroup command followed by the group name. For example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
/**
 * defgroup mygroup My Group
 * Description of my group.
 */

/** 
 * Function that belongs to the group mygroup.
 * ingroup mygroup
 */
void myFunction();


In this example, the defgroup command is used to define a group named "mygroup" with the description "My Group". The myFunction is then documented with the ingroup command to indicate that it belongs to the "mygroup" group.

Related Threads:

How to refer to a section of comments in doxygen?
How to group time column into 5 second intervals and count rows using presto?
How to change the config file for mathjax in doxygen?
How to group datetime into intervals of 3 hours in mysql?
How to backreference group when using or in regex?
How to know if doxygen is locked?