从Doxygen文档中排除某些类 [英] Exclude some classes from doxygen documentation

问题描述

我正在构建一个基于Qt的项目，并且在目标文档中找到了许多Qt类。

I am building a Qt based project, and many Qt classes are found in the target documentation.

我如何告诉Doxygen禁用某些类的文档生成？对于Q。*？

How can I tell Doxygen to disable documentation generation for some classes? For Q.*?

推荐答案

假设您拥有的东西是这样的：（这个问题有点不清楚

Working under the assumption that what you have is something like this: (The question is a little unclear in this regard)

/**
 * Some documentation for class X
 */
class X: public osg::Drawable {
...
}

并且您的问题是您想包含类 X 的文档，而不是类 osg :: Drawable 的文档，正确的方法是使用 EXCLUDE_SYMBOLS 。例如，在上述情况下使用

And your problem is that you want to include documentation for class X, but not for class osg::Drawable, the proper technique is to use EXCLUDE_SYMBOLS. For example, in the case above use

EXCLUDE_SYMBOLS = osg::Drawable

如果您想更加严格一些，可以使用

If you want to be slightly more rigorous, you can use

EXCLUDE_SYMBOLS = osg::Drawable \
                  Drawable

通配符也是允许，因此这也将起作用

Wild-cards are also allowed, so this will also work

EXCLUDE_SYMBOLS = osg::*

这篇关于从Doxygen文档中排除某些类的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！