Doxygen中预处理器的组级文档

Question

我有一个C / C ++头文件，该文件定义了多组预处理器符号。 这些组中的每个组都应在组级别具有自己的文档，并且应针对组中的每个符号使用单行文档。

我使用defgroup / addtogroup建立组，每个组都很好地显示在Modules选项卡中，其中带有所需的符号。

我无法实现的是小组级别的文档。 无论我尝试过什么，都会显示组级别的文档，但会作为该组第一个符号的文档。

例如：

/**
 * @defgroup group-1 Preprocessor symbols group 1
 * @{
 */
/**
 * @brief Brief description of group 1.
 *
 * Long description of group 1.
 */
#define GROUP1_SYM1 1  ///< Meaning of symbol 1
#define GROUP1_SYM2 2  ///< Meaning of symbol 2
/**
 * @}
 */

在输出中，该组的模块页面上有一个空的“详细说明”部分，“宏定义文档”部分中的GROUP1_SYM1条目包含：

Brief description of group 1.
Long description of group 1.
Meaning of symbol 1

我要实现的是，简短描述显示在该组的模块页面的顶部，长描述显示在“详细描述”部分，并且每个符号的描述仅包含单行描述，码。

我还尝试在#define语句周围添加@{和@} ，但这并没有改变任何内容。

我确实查看了Doxygen中的记录预处理器定义文档 ，但是尽管它显示了如何对预处理器符号定义进行分组，但它没有组级别的描述（组标题除外）。

我在Ubuntu 14.04上使用doxygen 1.8.6。

Answer 1

将组的文档放在组定义中，而不是在成员列表中的下方：

/**
 * @defgroup group-1 Preprocessor symbols group 1
 * 
 * @brief Brief description of group 1.
 *
 * Long description of group 1.
 */

/**
 * @addtogroup group-1
 * @{
 **/