Doxygen - переопределенный метод - комментарий не унаследован, почему?

Question

У меня есть два класса в PHP: Figure и Circle. Circle распространяется Figure. Figure имеет способ draw(). Circle наследует этот метод и отменяет его.

Метод draw() прокомментирован в родительском классе, но он не имеет комментария в классе Circle, поскольку он наследует его.

/** 
* Description of Figure 
* 
* @author admin 
*/ 
class Figure{ 

    /** 
    * Does something 
    */ 
    public function draw() { 

    } 
} 

/** 
* Description of Circle 
* 
* @author admin 
*/ 
class Circle extends Figure{ 


    public function draw() { 
     //overriden method 
    } 
} 

Doxygen говорит: "предупреждение: Член рисовать() (функция) класса Circle не документированы."

Как сделать Doxygen помещенным в унаследованный комментарий?

Answer 1

Вам необходимо сообщить Doxygen, где взять документацию, используя @copydoc annotation.

/** 
* Description of Circle 
* 
* @author admin 
*/ 
class Circle extends Figure { 

    /** 
    * @copydoc Figure::draw() 
    */ 
    public function draw() { 
     //overriden method 
    } 
} 

Внутри блока документации ниже @copydoc вы можете добавить больше документов, как, например, почему метод переопределяется.