从doxygen文档中排除某些类

在这样的假设下工作:(这方面的问题有点不清楚)

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

\internal 标签不起作用,你可以试试 \cond ... \endcond 标记代码的一部分对Doxygen隐藏的标记。

如果要排除特定文件,可以使用 EXCLUDE_PATTERNS 可变的 Doxyfile 配置文件。

private . 这将防止输出文档中包含该代码段。(我使用它来隐藏复制/移动构造函数/运算符,使其不会出现在API文档中。)

/*!
 * \brief This is included.
 */
class API
{
public:
    /*!
     * \brief So is this.
     */
    API() noexcept;
    /// \private
    ~API() noexcept; /* But this not, though technically public. */
private:
    int m_version; /* This is not either. */
}

但是应该注意,这是PHP的Doxygen扩展,根据 documentation 它们不应该被使用。

另一种选择是使用解决方案 mouviciel

虽然不是详细问题的正确答案,但它可能对问题标题的读者(如我)有所帮助。它也适用于classe!