【问题标题】:How can Doxygen exclude a C++ class?Doxygen 如何排除 C++ 类?
【发布时间】:2010-12-09 19:50:51
【问题描述】:

我想从 Doxygen 的文档中排除一个类。通常这些类位于同名文件中,但很多时候它们包含在其他类定义中。这主要用于以“_”或“Private”开头的类。

如何告诉 Doxygen 排除 C++ 类?

提前致谢。

【问题讨论】:

    标签: c++ doxygen


    【解决方案1】:

    您可以使用the \cond tag。在类定义之前,添加:

    \cond HIDDEN_SYMBOLS
    

    在类定义之后添加:

    \endcond
    

    除非您在 doxyfile 中定义 HIDDEN_SYMBOLS,否则不会记录 \cond\endcond 标记之间的内容。你可以用任何你喜欢的替换HIDDEN_SYMBOLS

    【讨论】:

    • 有没有办法在没有\cond\endcond 的源中做到这一点?也许像\nodoc\nodoxygen 在课堂上? Doxygen 手册中Special Commands 下没有看到命令,但我可能错过了。
    【解决方案2】:

    EXCLUDE_SYMBOLS 可能是我的答案。

    【讨论】:

      【解决方案3】:

      使用 Doxygen GUI,您可以在

      下找到多个排除选项
      "expert > input"
      

      您可能会发现特别有用:

      • 排除符号:排除包含确定的单词正则表达式的所有内容,例如 /word/
      • 排除模式:排除确定的路径正则表达式,例如 /folder//some/file.cs/

      【讨论】:

        猜你喜欢
        • 2015-08-16
        • 2010-11-28
        • 2021-12-28
        • 2011-11-17
        • 2011-08-03
        • 1970-01-01
        • 2014-07-22
        • 2011-01-03
        相关资源
        最近更新 更多