如何在没有Doxygens @copydoc的情况下记录重写/实现的函数?

时间:2010-10-22 09:06:29

标签: c++ documentation doxygen

如何记录子类的重写方法或实现的虚方法?我应该使用@copydoc吗?

class A {
   /**
    * A detailed description........
    */
   virtual int foo(int i);
}

class B : public A {
   /** {I won't write the same description again.} */
   int foo(int i);
}

1 个答案:

答案 0 :(得分:5)

如果重写该方法,它可能具有与子类实现不同的行为。在这种情况下,您应该只重写该方法的文档。

如果您想要相同的文档,可以使用INHERIT_DOCS选项。