search

rasodu / DLEMP

0 stars 0 forks source link

Install phpdoc on cmd image #24

Closed rasodu closed 8 years ago

rasodu commented 8 years ago

https://phpdoc.org/docs/latest/getting-started/your-first-set-of-documentation.html#running-phpdocumentor

If there is config file phpdoc, then setup up default config so phpdoc command always generates documentation for code in 'app' and the final destination will always be 'public/phpdoc-documentation/'

Install it on 'DLEMP/tools/phpdoc' and add 'DLEMP/tools/phpdoc/vendor/bin' to PATH

mkdir -p /DLEMP/tools/phpdoc
composer require --working-dir=/DLEMP/tools/phpdoc "phpdocumentor/phpdocumentor:2.*"
ENV PATH /DLEMP/tools/phpdoc/vendor/bin:$PATH

Command to generate documentation:

phpdoc template:list
phpdoc -d app/ -d tests/ -t public/app-documentation/ --template=zend

Config file explained: https://www.phpdoc.org/docs/latest/references/configuration.html