У меня есть два класса в 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 говорит:
msgstr «предупреждение: член draw () (функция) класса Circle не задокументирован.»
Как заставить Doxygen поместить в унаследованный комментарий?
Вы должны указать doxygen, где взять документацию, используя @copydoc
аннотирование.
/**
* Description of Circle
*
* @author admin
*/
class Circle extends Figure {
/**
* @copydoc Figure::draw()
*/
public function draw() {
//overriden method
}
}
Внутри блока документации ниже @copydoc
Вы можете добавить больше документации, например, почему метод переопределен.
Других решений пока нет …