Exclude some classes from doxygen documentation

前端 未结 3 1454
执念已碎
执念已碎 2020-12-31 03:57

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 clas

3条回答
  •  渐次进展
    2020-12-31 04:25

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

提交回复
热议问题