theseer / phpdox
A fast Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT) with event based processing
Installs: 2 287 260
Dependents: 169
Suggesters: 8
Security: 0
Stars: 600
Watchers: 26
Forks: 121
Open Issues: 50
Requires
- php: >=7.1
- ext-dom: *
- ext-fileinfo: *
- ext-iconv: *
- ext-mbstring: *
- ext-tokenizer: *
- ext-xsl: *
- nikic/php-parser: ^4.2
- phpunit/php-timer: ^2.0
- theseer/directoryscanner: ^1.3.0
- theseer/fdomdocument: ^1.6
- theseer/fxsl: ^1.1
README
phpDox is a documentation generator for PHP projects. This includes, but is not limited to, API documentation. The main focus is on enriching the generated documentation with additional details like code coverage, complexity information and more.
Requirements
- PHP Version 7.1+ (For PHP 5.5+, use phpDox 0.11.2)
- ext/dom
- ext/xsl
- ext/iconv and libiconv version >= 2.12
- PHPParser PHP Parser API
- fDOMDocument
- DirectoryScanner
- fXSL
- PHP_Timer
Phar Installation
phpDox is shipping as a selfcontained executable phar archive. You can grab your copy from the releases section or install using phive:
phive install phpdox
You can now execute phpdox on the command line:
tools/phpdox --version
If everything worked out, you should get an output like this:
phpDox 0.11.2 - Copyright (C) 2010 - 2018 by Arne Blankerts and Contributors
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"
Composer Installation
Additionally, phpDox can be installed via composer:
composer require --dev theseer/phpdox
You can now execute phpdox on the command line:
vendor/bin/phpdox --version
If everything worked out, you should get an output like this:
phpDox 0.11.2 - Copyright (C) 2010 - 2018 by Arne Blankerts and Contributors
Developer Installation
In case you want to go bleeding edge or hack on the source, you will have to clone this repository.
git clone git://github.com/theseer/phpdox.git
composer install
Usage Examples
You can run phpDox like this:
phpdox --help
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
phpdox
or you can tell phpdox what configuration file to use by calling switch --file or in short
phpdox -f path/to/phpdox.xml