Doxygen如何排除C ++类?

问题描述 投票:12回答:3

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

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

提前致谢。

c++ doxygen
3个回答
15
投票

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

\cond HIDDEN_SYMBOLS

并在类定义之后添加:

\endcond

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


12
投票

EXCLUDE_SYMBOLS可能是我的答案。


2
投票

使用Doxygen GUI,您可以在下面找到多个排除选项

"expert > input"

您可能会发现特别有用:

  • 排除符号:排除包含确定单词正则表达式的所有内容,例如/ word /
  • 排除模式:排除已确定的路径正则表达式,如/ folder /或/some/file.cs/
© www.soinside.com 2019 - 2024. All rights reserved.