Doxygen组和模块索引

Question

我正在为我的项目创建一个Doxygen文档.最近,我使用\addtogrouptag 对相关类进行了分组.在此之后,我的文档中有一个模块选项卡.它显示了所有模块.我想在同一页面上的模块名称下面的模块名称下面添加一些描述.我怎么能用Doxygen做到这一点？

这是我的标签

/*! \addtogroup test test
 *  Test Testing a group in doxygen
 *  @{
 */

Answer 1

您必须编写一个仅包含注释的专用.h文件.对于每个组,您可以定义如下注释:

/** @defgroup FooGroup
 *
 * This module does yada yada yada
 *
 */

然后将分配定义到组(即使在不同的文件上),如下所示:

/** @addtogroup FooGroup */
/*@{*/

/** Summon a goat
 *
 * @param name The name of the goat;
 * @return The summoned goat;
 */
Goat summon_goat (const char *name);

...
...

/*@}*/

编辑:

另外这是怎么变成.请参阅"详细说明"？您还可以在@verbatim和@endverbatim命令中添加代码段和示例.