如何对文件文档枚举进行多行

how to multi-line a file documentation enum?

本文关键字:枚举 文档 文件      更新时间:2023-10-16

我正在使用doxygen来记录一些像这样的c ++枚举:

/** Members */
enum {
  MEMBER_ONE, /*!< This is member one */
  MEMBER_TWO  /*!< This is member two */
} members;

文档看起来不错,但问题是带有指向文档的超链接的代码(我说的是文件文档中的部分,如下所示:

文件文档

文件1.h

枚举 { MEMBER_ONE, MEMBER_TWO };

在枚举源代码的所有成员中没有任何换行符。有什么方法可以强制 doxygen 尊重换行符或插入换行符?放入
注释仅适用于文档本身

Doxygen 会重新格式化枚举的值,但您可以通过ENUM_VALUES_PER_LINE配置选项控制一行上显示的元素数量。因此,您可以将其设置为 1 以像原始源代码中一样每行获取一个项目。