Doxygen c++：使用&quot；声明公开的私有继承成员文档 [英] doxygen c++ : document privately inherited members exposed by the "using" declaration

问题描述

作为示例，我有以下类：

class A {
    public:
        void methodOne();
}

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

我还没有找到强制doxygen拾取文档块的方法。

作为约束，我有许多其他doxygen记录的私有成员(也来自其他类)，我不希望doxygen为其处理文档块，因此EXTRACT_PRIVATE不是一个选项，即使使用像cond...这样的条件块。Endcond。

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

谢谢您的帮助。

推荐答案

我也遇到了这个问题。尽管相当难看，但一种解决方案是在Doxx文件中设置PREDEFINED选项，并使用#ifdef预处理器指令将成员函数实际添加到派生类中。

因此，例如，使用包含：

的Dox文件

PREDEFINED = _DOXYGEN_

来源定义如下：

class A {
    public:
        void methodOne();
}

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

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

这是我想过的记录此类声明的唯一方法，因为Doxo不支持此功能。

这篇关于Doxygen c++：使用&quot；声明公开的私有继承成员文档的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！