Exclude some classes from doxygen documentation

elcuco picture elcuco · Sep 16, 2009 · Viewed 21.8k times · Source

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

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

Answer

Ben Hocking picture Ben Hocking · Mar 17, 2010

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 {
...
}

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::*