KarleKremen
@KarleKremen
Игнорирую Bootstrap

Почему phpDocumentor не подхватывает документацию в файле?

Написал тут документацию к своему велосипеду, решил собрать. Собираю и получаю вот такую магию:
Parsing /home/kkremen/PhpstormProjects/intranet-core/core/module/common-module.php
  No summary for method __construct()
  No summary for method __destruct()
  No summary for method newConfigReader()
  No summary for method newConfigWriter()
  No summary for method openDBTable()
  No summary for method openResource()
  No summary for method loadView()
  No summary for method newSession()
  No summary for method newCookieReader()

Триста раз проверил этот гребаный файл - все в порядке, комменты стоят - а документор все равно плюется. Кто-нибудь сталкивался, знает, что ему надо?

UPD: pastebin.com/zU2hwCWy - ссылка на сам файлик
  • Вопрос задан
  • 320 просмотров
Решения вопроса 1
/**
 * @see CommonModule::onLoad()
 * CommonModule constructor. 
* You can not change the constructor directly, but you can use onLoad function instead.
 */
final function __construct()

Указывать @see перед описанием (summary) неправильно.

https://www.phpdoc.org/docs/latest/guides/docblock...

be57b9047f6548b1822476458e094357.png
Нужно изменить порядок, сначала должно идти summary, затем может идти description и только потом tags (@see - относится к tags):

/**
 * CommonModule constructor. 
 * You can not change the constructor directly, but you can use onLoad function instead.
 *
 * @see CommonModule::onLoad()
 */
final function __construct()
Ответ написан
Комментировать
Пригласить эксперта
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы