【问题标题】:How to exclude undocumented member functions/variables of a class from doxygen output? [duplicate]如何从 doxygen 输出中排除类的未记录成员函数/变量? [复制]
【发布时间】:2017-05-03 09:57:53
【问题描述】:

正如标题所示,这可能吗?

基本上,任何未记录的内容都不会出现在输出中。

【问题讨论】:

    标签: c++ doxygen


    【解决方案1】:

    我通常只导出必要的,所以:(也没有静态和私有)

    # do not extract all
    EXTRACT_ALL            = NO
    EXTRACT_PRIVATE        = NO
    EXTRACT_STATIC         = NO
    

    并且还隐藏未注释的东西:

    # hide undoc stuff
    HIDE_UNDOC_MEMBERS     = YES
    HIDE_UNDOC_CLASSES     = YES
    HIDE_FRIEND_COMPOUNDS  = YES
    HIDE_IN_BODY_DOCS      = YES
    

    执行此操作后,将仅处理您在其中使用 @file 标记的文件,并且仅考虑记录的元素。

    (doxygen 1.8.13)

    【讨论】:

      【解决方案2】:

      来自the FAQ

      您的类/文件/命名空间是否记录在案?如果没有,除非在配置文件中将 EXTRACT_ALL 设置为 YES,否则不会从源中提取它。

      所以,将其设置为 NO。

      【讨论】:

      • 我确实将它设置为 NO,但我认为它只适用于全局函数/类......而不是成员函数。
      猜你喜欢
      • 2016-08-27
      • 2010-11-04
      • 2014-07-22
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2013-06-04
      • 2020-08-05
      • 1970-01-01
      相关资源
      最近更新 更多