Используя phpDoc, я не получаю ошибок, но и результатов тоже нет

Question

С несколькими файлами вроде этого:

/**
 * Creates a new user account.
 * Collects posted form variables, escapes them, then passes them on to Storm.
 * @package User
 */

/**
 * Do includes.
 */
include_once('../Utilities.php');
include_once('../stormLibs/user.php');

...так далее.

Затем я запускаю phpDocumentor 2 с phpdoc.org. На странице результатов нет ошибок, но также нет ссылок на какие-либо файлы, пакеты или классы.

Есть идеи?

Скриншот:

Answer 1

Странно, что сам файл даже не отображается в списке пакета пользователя. Интересно, работает ли phpdoc2 так, что файл присоединяется к списку пакетов только в том случае, если он также содержит некоторый документируемый элемент (класс, функция, константа). Если ваш файл представляет собой только процедурный код, вероятно, там нет документируемых элементов, и поэтому phpdoc2 считает, что ему нечего документировать.

В качестве эксперимента, если ваш файл действительно не содержит документируемых элементов, попробуйте добавить пустое объявление класса, которое включает в себя докблок уровня класса, который помещает его в пакет User. Мне было бы интересно посмотреть, если из-за этого и класс, и файл появятся в списке пакетов пользователя.