c++ - 如何使用 Doxygen 更改派生类中的函数描述？

Question

我有两个类:

class A {
public:
  /** Brief description
   * Grand description
   */
  virtual void func() {
    // Do something.
  }
};

class B: public A {
  // How to re-describe func() here?
};

我已经在 Doxygen 配置中打开了描述继承，这没问题。但我想将派生类中的描述更改为在基类中实现的一些函数，无需重新实现这些函数。

当然，我可以做到以下几点:

class B: public A {
public:
  /** My new description.
   * ...
   */
  virtual void func() {
    A::func();
  }
};

但它对我来说似乎“丑陋”- 编写不必要的代码只是为了添加一些注释。

还有其他解决方案吗？

Answer 1

如果你真的想要，你也可以使用预处理器技巧:

class B: public A {
  public:

#ifdef ONLY_FOR_DOXYGEN
    /** Beautiful docs */
    virtual void func();
#endif
};

连同这些设置:

ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = YES
PREDEFINED             = ONLY_FOR_DOXYGEN

这样只有 doxygen 才能看到额外的代码。