开发者

How to document overridden/implemented functions without Doxygens @copydoc?

How can I document an overridden method or an implemented virtual method of a sub class? Should I use @copydoc?

class A {
   /**
    * A detailed description.开发者_如何学C.......
    */
   virtual int foo(int i);
}

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


If the method is overridden it probably has different behavior than the subclass implementation. In that case you should just rewrite the documentation for that method.

If you want the same documentation regardless, you can use the INHERIT_DOCS option.

0

上一篇:

下一篇:

精彩评论

暂无评论...
验证码 换一张
取 消

最新问答

问答排行榜