从doxygen文档中排除一些类

Question

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

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

Answer 1

假设你拥有的东西是这样的:(问题在这方面有点不清楚)

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

而你的问题是你想要包含类的文档X,但不包括类osg::Drawable,正确的技术是使用EXCLUDE_SYMBOLS.例如,在上述情况下使用

EXCLUDE_SYMBOLS = osg::Drawable

如果你想稍微严格一点,你可以使用

EXCLUDE_SYMBOLS = osg::Drawable \
                  Drawable

也允许使用通配符,因此这也可以使用

EXCLUDE_SYMBOLS = osg::*

Answer 2

如果\internal标签不起作用,您可以尝试使用\cond ... \endcond标签来标记要从Doxygen中隐藏的部分代码.

编辑

如果要排除特定文件,可以EXCLUDE_PATTERNS在Doxyfile配置文件中使用变量.