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-07-03 15:46:10 +00:00
|
|
|
Details about [installing phpDocumentor](https://phpdoc.org/docs/latest/getting-started/installing.html)
|
2015-08-16 13:55:31 +00:00
|
|
|
can be found in its own documentation.
|
|
|
|
|
|
|
|
|
|
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/
|
|
|
|
|
```
|
