doxygen c ++：记录由“using”声明公开的私有继承成员

Question

举个例子，我有以下几个类：

class A {
    public:
        void methodOne();
}

class B : private A {
    public:
        /** Brief description.
        */
        using A::methodOne;
}

我还没有找到一种强制doxygen来获取文档块的方法。

作为约束，我还有许多其他的doxygen文档的私有成员（也来自其他类），我不想让doxygen处理文档块，所以即使使用像\ cond这样的条件块，EXTRACT_PRIVATE也不是一个选项。 \ ENDCOND。

我找到了一些可能有用的example。它使用INPUT_FILTER配置变量有效地定位一些标记的私有成员，并在将文件提供给doxygen之前将其声明更改为public。不幸的是，这并不适用于我的情况，因为该方法在技术上已经被公开。

谢谢你的帮助。

Answer 1

我也遇到了这个问题。一个解决方案，虽然相当丑陋，但是在Doxy文件中设置PREDEFINED选项并使用#ifdef预处理程序指令在Doxygen生成文档时实际将成员函数添加到派生类。

因此，例如，使用包含以下内容的Doxyfile：

PREDEFINED = _DOXYGEN_

来源可以定义如下：

class A {
    public:
        void methodOne();
}

class B : private A {
    public:
        #ifdef _DOXYGEN_
        /** Brief description.
        */
        void methodOne();
        #endif
        using A::methodOne;
}

这很糟糕，但最糟糕的是必须从基类复制函数声明，因此如果声明发生更改，则需要记住更新派生类文档。

这是我考虑记录此类声明的唯一方法，因为Doxygen不支持此功能。