c – doxygen – 如何多行文件文档枚举?

我正在使用doxygen来记录这样的一个c enum:

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

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

File Documentation

file1.h

enum { MEMBER_ONE, MEMBER_TWO };

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

解决方法:

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

上一篇:FragMent 初级学习


下一篇:Doxygen:是否可以对C函数参数进行分组,即具有相同的文档而不重复它?