doxygen - 如何多行文件文档枚举?

时间:2013-10-20 12:10:55

标签: c++ doxygen

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

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

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

  

档案文件

     

file1.h

     

枚举{MEMBER_ONE,MEMBER_TWO};

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

1 个答案:

答案 0 :(得分:5)

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