phpDox is a documentation generator for PHP projects. This includes, but is not limited to, API documentation.
- PHP Version 5.3.3+
- ext/iconv and libiconv version >= 2.12
- PHPParser PHP Parser API
phpDox is shipping as a selfcontained executable phar archive. You can grab your copy here:
Installation is simple:
wget http://phpdox.de/releases/phpdox.phar chmod +x phpdox.phar sudo mv phpdox.phar /usr/bin/phpdox
You can now execute phpdox on the command line:
If everything worked out, you should get an output like this:
phpDox 0.7.0 - Copyright (C) 2010 - 2014 by Arne Blankerts
Note: Starting with release 0.6.6 the pear package distribution is merely a wrapper for the selfcontained phar.
Note: Some Linux distributions ship PHP with ext/suhosin and disabled phar execution. To make use of phpDox in such an environment, you need to enable phar execution by adding phar to the executor white list: suhosin.executor.include.whitelist="phar"
In case you want to go bleeding edge or hack on the source, you will have to clone this repository.
phpdox.php bootstrap file assumes that all depedencies have been installed using the PEAR Installer.
In case you do clone the source repository and used composer for the dependency management, you have to use the provided
wrapper in composer/bin/phpdox.
git clone git://github.com/theseer/phpdox.git composer install
You can run phpDox like this:
As of version 0.4 phpDox requires an xml configuration file. In case a project you want to generate documentation for does not come with one, you can create it by calling
phpdox --skel > phpdox.xml.dist
Sample invocation to parse and generate output based on the default phpdox.xml configuration file