【问题标题】:How to document overridden/implemented functions without Doxygens @copydoc?如何在没有 Doxygens @copydoc 的情况下记录覆盖/实现的函数?
【发布时间】:2010-10-22 09:06:29
【问题描述】:

如何记录子类的重写方法或实现的虚拟方法?我应该使用@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);
}

【问题讨论】:

    标签: c++ documentation doxygen


    【解决方案1】:

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

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

    【讨论】:

    • 哦,其实我的意思是特别针对实现的虚拟功能。
    • @elgcom:编辑了我的答案。希望对您有所帮助。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2018-06-29
    • 1970-01-01
    • 2019-06-29
    • 2019-01-09
    • 2017-04-11
    • 2014-01-31
    • 1970-01-01
    相关资源
    最近更新 更多