c++ - Doxygen 组和模块索引

Question

我正在为我的项目创建一个 Doxygen 文档。最近，我使用\addtogroup标签对相关类进行了分组。在此之后，我的文档中有一个模块选项卡。它显示所有模块。我想在同一页面上模块名称下方的模块名称下方添加一些描述。我怎样才能使用 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);

...
...

/*@}*/

编辑：

这也是它的样子。见“详细说明”？您还可以在@verbatimand@endverbatim命令中添加代码片段和示例。