Doxygen如何排除C++类?

cuxqih21  于 2022-12-20  发布在  其他
关注(0)|答案(3)|浏览(176)

我想从Doxygen的文档中排除一个类。通常这些类都在同名的文件中,但也有很多时候它们被包含在其他类定义中。这主要是针对以"_"或"Private"开头的类。
我如何告诉Doxygen排除一个C++类?
先谢了。

bis0qfac

bis0qfac1#

可以使用\cond标签,在类定义前添加:

\cond HIDDEN_SYMBOLS

并在类定义后添加:

\endcond

除非您在doxy文件中定义了HIDDEN_SYMBOLS,否则\cond\endcond标签之间的内容将不会被记录。您可以用任何您喜欢的内容替换HIDDEN_SYMBOLS

k3fezbri

k3fezbri2#

EXCLUDE_SYMBOLS可能是我的答案。

ebdffaop

ebdffaop3#

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

"expert > input"

你可能会发现特别有用的:

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

相关问题