PHPDocumentor — что не так с моим DocBlock?

Я добавляю комментарии к устаревшему коду и столкнулся с небольшой проблемой в PHPDocumentor.

Вот пример:

/**
 * Constructs the Widget object
 * 
 * Basic constructor for the widget object.
 * Another line of pointless explanation, badly worded.
 *
 * @param  string   $id    The ID of the widget
 * @param  int      $size  The Size of the widget
 * @throws InvalidArgumentException
 */
public function __construct($id, $size) {
    if (!is_string($id) || !is_integer($size)) {
        throw new InvalidArgumentException('$id must be a string, $size an integer');
    }
    $this->id = $id;
    $this->size = $size;
}

Я запускаю PHPDocumentor из командной строки и получаю прекрасную папку с документацией.

Документация выглядит нормально, но я получаю ошибки компиляции PHPDocumentor в следующих строках:

Argument $id is missing from the Docblock of __construct

Это просто PHPDocumenator без необходимости ноет, или есть что-то очевидное, что я упускаю?


person Dycey    schedule 30.10.2014    source источник
comment
Вы уверены, что он указывает на этот файл?   -  person Cheery    schedule 31.10.2014
comment
Ага! Сама документация выглядит полной, но в файле errors.html по-прежнему появляются ошибки.   -  person Dycey    schedule 31.10.2014
comment
Может ли быть, что какая-либо буква введена в другой раскладке клавиатуры, отличной от ASCII?   -  person Cheery    schedule 31.10.2014
comment
__construct не возвращает значение, поэтому здесь не должно быть @return void. Просто придирка :)   -  person AJenbo    schedule 14.03.2020
comment
Хороший улов. Аполс.   -  person Dycey    schedule 15.03.2020


Ответы (1)


У меня была такая же проблема с phpDocumentor версии 2.8.1. Кажется, это ошибка в этой версии: введите здесь описание ссылки

Я использовал версию 2.7.0, и теперь все в порядке.

person Ehsan    schedule 07.12.2014
comment
Ссылка Ehsan ведет вас к объяснению неисправленной проблемы, которую можно исправить, создав и установив исправление из исходного кода GitHub. Надеюсь, это будет исправлено в 3.0. - person Dycey; 08.12.2014