Doxygen - überschriebene Methode - der Kommentar wird nicht vererbt, warum?

Question

Ich habe zwei Klassen in PHP: Figure und Circle. Circle erweitert Figure. Figure hat eine Methode draw(). Circle erbt diese Methode und überschreibt sie.

Die Methode draw() ist in der übergeordneten Klasse kommentiert, hat jedoch keinen Kommentar in der Klasse Circle, da sie es erben soll.

/** 
* 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 sagt: "Warnung: Mitglied ziehen() (Funktion) der Klasse Circle nicht dokumentiert."

Wie kann man Doxygen in den geerbten Kommentar einfügen?

Answer 1

Sie müssen Doxygen sagen, woher er die Dokumentation nehmen soll, mit @copydoc annotation.

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

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

Innerhalb der Dokumentation Block unter @copydoc Sie weitere Dokumentation hinzufügen können, wie zum Beispiel, warum die Methode überschrieben wird.