2015-08-16 13:55:31 +00:00
|
|
|
Generating documentation
|
|
|
|
|
========================
|
|
|
|
|
|
|
|
|
|
In order to generate the documentation, you will need to install the following
|
|
|
|
|
packages and its dependencies:
|
|
|
|
|
* phpdoc
|
|
|
|
|
* graphviz
|
|
|
|
|
|
2016-08-22 08:58:01 +00:00
|
|
|
Details about
|
|
|
|
|
[installing phpDocumentor](https://phpdoc.org/docs/latest/getting-started/installing.html)
|
|
|
|
|
can be found in that projects documentation.
|
2015-08-16 13:55:31 +00:00
|
|
|
|
|
|
|
|
Example for Debian and Ubuntu:
|
2016-07-03 15:45:37 +00:00
|
|
|
```console
|
|
|
|
|
$ sudo aptitude install php-pear graphviz
|
|
|
|
|
$ sudo pear channel-discover pear.phpdoc.org
|
|
|
|
|
$ sudo pear install phpdoc/phpDocumentor
|
|
|
|
|
```
|
2015-08-16 13:55:31 +00:00
|
|
|
|
|
|
|
|
To generate the documentation, change into the main directory and run phpdoc:
|
2016-07-03 15:45:37 +00:00
|
|
|
```console
|
2016-07-11 09:58:15 +00:00
|
|
|
$ cd PrivateBin
|
2016-07-03 15:45:37 +00:00
|
|
|
$ phpdoc -d lib/ -t doc/
|
|
|
|
|
```
|
2016-08-22 08:58:01 +00:00
|
|
|
|
|
|
|
|
**Note:** When used with PHP 7, the prerelease of phpDocumentator 2.9 needs to be
|
|
|
|
|
manually installed by downloading it from
|
|
|
|
|
[GitHub](https://github.com/phpDocumentor/phpDocumentor2/releases/download/v2.9.0/phpDocumentor.phar)
|
|
|
|
|
and then manually moving it to e.g. `/usr/local/bin` and making it executable.
|
