CRTP函数特化：添加到接口函数的docstring中

Question

我正在实现由 CRTP 派生的类。这需要在需要时进行函数专门化。现在，对于派生类中的特定专业化，我想在“全局”接口函数的文档字符串中添加一些内容。我该怎么做（使用 doxygen 1.9.1）？

示例

考虑这个例子：

template <class D>
class CommonInterface
{
public:
    /**
    \brief My common function description.
    */
    void foo()
    {
        static_cast<D*>(this)->foo_impl();
    }
};

class A : public CommonInterface<A>
{
public:
    A() = default;

private:
    void foo_impl() {};

    friend class CommonInterface<A>;
};

A::foo() 在A 的文档中显示为CommonInterface<D>::foo 的派生方法。现在，我想为 foo 方法添加一些文档，这些文档仅在 class A 的文档中可见，而在 class CommonInterface 的文档中不可见。

我不想：

• 重写函数，而是专门使用 CRTP 来避免重写，因为我使用模板化的“重写”。
• 文档foo_impl()，因为它在公共文档中没有任何意义。

Answer 1

不是答案，而是解决方法？

我认为 doxygen 中不存在这种情况，但也许以下可能是可接受的解决方法？

Doxyfile

EXTRACT_ALL            = YES
QUIET                  = YES
MACRO_EXPANSION        = YES
PREDEFINED             = DOXYGEN
HAVE_DOT               = YES
CALL_GRAPH             = YES
CALLER_GRAPH           = YES

aa.h

template <class D>
class CommonInterface
{
public:
    /**
    \brief My common function description.
    \details My common function detailed description.
    */
#if DOXYGEN
virtual
#endif
    void foo()
    {
        static_cast<D*>(this)->foo_impl();
    }
};

class A : public CommonInterface<A>
{
public:
    A() = default;

#if DOXYGEN
/**
\copydoc CommonInterface::foo

Some extra documentation for A::foo ?
*/
    void foo()
    {
        static_cast<D*>(this)->foo_impl();
    }
#endif
private:
    void foo_impl() {};

    friend class CommonInterface<A>;
};