【问题标题】:Doxygen doesn't generate documentation for enum not in classDoxygen 不会为不在类中的枚举生成文档
【发布时间】:2014-09-11 12:26:17
【问题描述】:

我在命名空间内有一个枚举,但在一个类之外。除非我启用 EXTRACT_ALL,否则 Doxygen 不会记录枚举,这会提取太多不必要的内容。

使用它的地方不链接枚举(如果我使用EXTRACT_ALL,它会链接)。枚举及其成员已记录在案(并且文档按预期显示为EXTRACT_ALL)。如果没有该设置,枚举不会出现在任何地方的文档中。

我可以使用比使用EXTRACT_ALL 更精确的其他设置吗?

我目前启用了EXTRACT_PRIVATEEXTRACT_PACKAGEEXTRACT_STATICEXTRACT_LOCAL_CLASSESEXTRACT_ANON_NSPACES,但各种HIDE_* 设置都处于关闭状态。

【问题讨论】:

    标签: c++ enums doxygen


    【解决方案1】:

    检查文件是否包含\file 命令。

    来自\file 的手册(我的重点):

    全局函数、变量、类型定义和枚举的文档 只有当它们所在的文件是 也记录在案。

    here

    【讨论】:

    • 如果枚举位于命名空间中,则应改为记录命名空间。通过在其中一个命名空间块前面添加一个特殊注释,或者通过在输入中的某处使用 \namespace 命令放置一个特殊注释。
    • 这是因为枚举包含在文档中,但无论出于何种原因,该类都没有链接到枚举类型(它与EXTRACT_ALL 链接。此外,枚举的成员不是t 记录。使用EXTRACT_ALL,枚举显示在命名空间页面(而不是文件页面)上,因此它可能与此有关。
    • 枚举缺乏文档肯定与它是全球性的事实有关。将枚举移动到类中会导致其成员出现在文档中(如预期的那样)。
    • 此外,命名空间和文件都已记录在案。命名空间页面只包含(命名空间的)“详细描述”,没有其他内容(比如这个枚举)。
    猜你喜欢
    • 2012-01-04
    • 1970-01-01
    • 1970-01-01
    • 2014-05-18
    • 2014-01-17
    • 2018-12-09
    • 1970-01-01
    • 1970-01-01
    • 2013-10-28
    相关资源
    最近更新 更多