【问题标题】:doxygen - how to multi-line a file documentation enum?doxygen - 如何多行文件文档枚举?
【发布时间】:2013-10-28 22:06:05
【问题描述】:

我正在使用 doxygen 来记录一些 c++ 枚举,如下所示:

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

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

文件文档

file1.h

枚举 { MEMBER_ONE, MEMBER_TWO };

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

【问题讨论】:

    标签: c++ doxygen


    【解决方案1】:

    Doxygen 会重新格式化枚举值,但您可以通过 ENUM_VALUES_PER_LINE 配置选项控制一行中出现多少元素。因此,您可以将其设置为 1 以获取每行一项,就像在原始源代码中一样。

    【讨论】:

    • 谢谢!我的目标是 Latex PDF 而不是 HTML 文档,有机会在 tex 文件上这样做吗?
    猜你喜欢
    • 2012-05-01
    • 2014-09-11
    • 2021-07-11
    • 2018-09-14
    • 2013-12-24
    • 2014-05-30
    • 2015-01-12
    • 2014-04-10
    • 1970-01-01
    相关资源
    最近更新 更多