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

Question

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

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

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

PS：也许这个 ASCII 图形会更清晰一些。

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

Answer 1

您可以使用 @name @{ .. @} 对 #define 进行分组。这是一个小例子。在配置文件中将 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

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

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

doxygen: two makros in one description box

documentation

doxygen

code-documentation