doxygen：一个描述框中的两个 makros

Question

我想在我的 doxygen HTML 文档中连接两个相关的 define-makros，使它们显示在一个描述框中。

我希望我能清楚地描述它应该是什么样子：通常每个定义语句都有自己的描述框，使用/** @define <description> */。这会产生一个描述框，其中代码部分位于框的标题行中，而简短的描述位于框的内容中。

我现在要做的是将两个定义语句连接起来，使它们显示在一个带有通用描述的框中。有人知道实现这一点的方法吗？

PS：这个 ASCII 图形可能会更清晰一些。

+-------------------------+ | #define PORT 1 | | #define PORTDIR 0 | +-------------------------+ | output port definitions | +-------------------------+

Answer 1

您可以使用@name @{ .. @} 对#defines 进行分组。这是一个小例子。在配置文件中同时将SUBGROUPING 设置为NO 时效果最佳。

/** @file
 *  File documentation
 */

/** @name Output ports definitions
 *  @brief Brief description for the group.
 *  @{
 */
#define PORT    1 /**< @brief The port number */
#define PORTDIR 0 /**< @brief The port direction */
/** @} */

/** @brief A lonely macro */
#define LONELY  2

当您省略单个宏的文档时，您会关闭您所请求的内容，只有文档在组上方而不是在组下方。