如何Doxygen排除一个C ++类？ [英] How can Doxygen exclude a C++ class?

问题描述

我想从Doxygen的文档中排除一个类。通常这些类在名称相同的文件中，但是有很多次它们被包括在其他类定义中。

I want to exclude a class from documentation in Doxygen. Usually these classes are in files named the same, but there are many times when they are included inside other class definitions. This is mainly for classes starting with "_" or "Private".

感谢，
Kris

Thanks, Kris

推荐答案

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

You can use the \cond tag. Before the class definition, add:

\cond HIDDEN_SYMBOLS

并在类定义之后添加：

\endcond

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

Unless you define HIDDEN_SYMBOLS in your doxyfile, the contents between the \cond and \endcond tags will not be documented. You can replace HIDDEN_SYMBOLS with whatever you like.

这篇关于如何Doxygen排除一个C ++类？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！