Как документировать переопределенные / реализованные функции без Doxygens @copydoc?

Question

Как я могу документировать переопределенный метод или реализованный виртуальный метод подкласса? Должен ли я использовать @ 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);
}

Answer 1

Если метод переопределен, он, вероятно, имеет другое поведение, чем реализация подкласса.В этом случае вам просто нужно переписать документацию по этому методу.

Если вы хотите получить одинаковую документацию независимо от этого, вы можете использовать опцию INHERIT_DOCS.