documentation - doxygen: two makros in one description box

Question

I want to connect two related define-makros in my doxygen HTML-documentation in such a way, that they are shown in a single description box.

I hope I can describe clearly how it should look like: Normally every define statement gets its own description box using /** @define <description> */. This results in a description box with the code part in the title line of the box and a short description in the box content.

What I want to do now is to connect two define statements in such a way that they are shown in a single box with a common description. Does anybody knows a way to realize that?

PS: Maby it gets a little bit clearer with this ASCII graphic.

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

Answer 1

您可以使用 对#defines 进行分组@name @{ .. @}。这是一个小例子。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

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