phpDocumentor на Ubuntu
Установка
Для простейшей установки необходим PEAR.
sudo apt-get install php-pearОфициальный способ установки
sudo pear channel-discover pear.phpdoc.org
sudo pear install phpdoc/phpDocumentorНа март 2018 года этот способ установки через PEAR не работает. Формально он работает, но phpdoc после такой устновки выдает ошибку связанную с dompdf.
PHP Warning: require_once(/dompdf/dompdf/dompdf_config.inc.php): failed to open stream: No such file or directory in /usr/share/php/phpDocumentor/src/phpDocumentor/Bootstrap.php on line 178
PHP Fatal error: require_once(): Failed opening required '/dompdf/dompdf/dompdf_config.inc.php' (include_path='.:/usr/share/php') in /usr/share/php/phpDocumentor/src/phpDocumentor/Bootstrap.php on line 178Поэтому предлагается скачать tgz архив с репозитария phpDocumentor на GitHub и запустить PEAR установку с этого пакета.
wget https://github.com/phpDocumentor/phpDocumentor2/releases/download/v2.9.0/phpDocumentor.phar
sudo pear install phpDocumentor-2.9.0.tgzПо окончании установки будет доступна команда phpdoc
phpdoc --versionИспользование
В простейшем случае, находясь в директории проекта, просто запустите комнду phpdoc из консоли:
phpdoc -d ./Основной ситаксис использования:
phpdoc -d ./src -t ./docs --template responsiveВ приведенном примере выполняется проверка всех файлов в каталоге src и его подкаталогах, документация помещается в папку docs. Если опустить опцию -t, ты вывод будет записан в папку output. Для анализа выбранного каталого используется ключ -d, для выбранного файла — -f. В качестве шаблона используется responsive.
Список шаблонов:
phpdoc template:list