| .. | ||
| README.md | ||
Generating documentation
In order to generate the documentation, you will need to install the following packages and its dependencies:
- phpdoc
- graphviz
Details about installing phpDocumentor can be found in that projects documentation.
Example for Debian and Ubuntu:
$ sudo aptitude install php-pear graphviz
$ sudo pear channel-discover pear.phpdoc.org
$ sudo pear install phpdoc/phpDocumentor
To generate the documentation, change into the main directory and run phpdoc:
$ cd PrivateBin
$ phpdoc -d lib/ -t doc/
Note: When used with PHP 7, the prerelease of phpDocumentator 2.9 needs to be
manually installed by downloading it from
GitHub
and then manually moving it to e.g. /usr/local/bin and making it executable.