Doxygen如何排除C ++类？

Question

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

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

提前致谢。

Answer 1

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

\cond HIDDEN_SYMBOLS

并在类定义之后添加：

\endcond

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

Answer 2

EXCLUDE_SYMBOLS可能是我的答案。

Answer 3

使用Doxygen GUI，您可以在

下找到多个排除选项

"expert > input"

您可能会发现特别有用：

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