arno
/
privatebin
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '77f464f650'
${ noResults }
privatebin/doc
History
El RIDO 62dd25b91a
added note for phpdoc with PHP 7 		8 years ago
..
README.md added note for phpdoc with PHP 7 8 years ago

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.