Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT)
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.
 
 
 
 
 
Go to file
Adam Jones 1aa70b1451
PHP8.1 - more sticking plaster fix : added some #[\ReturnTypeWillChange] (also requires a change in theseer/fDOMDocument)
11 months ago
bootstrap Rework autoload handling (fixes #179, fixes #181) 9 years ago
build Revert "Revert "Add notice to output about deprecation of HHVM and PHP < 5.6"" 7 years ago
dependencies/php Update php core dependency data 5 years ago
schema XMLNS Cleanup: Removed left over # from namespare uris 10 years ago
src PHP8.1 - more sticking plaster fix : added some #[\ReturnTypeWillChange] (also requires a change in theseer/fDOMDocument) 11 months ago
templates/html Remove debug line (context dump) [PR #354] 5 years ago
tests Adopt fXSL as project is archived and we need to address a BC issue 3 years ago
.gitignore Add php-cs-fixer cache to gitignore 5 years ago
.php_cs.dist Add php-cs-fixer config 5 years ago
.travis.yml Fix travis-ci cfg 4 years ago
CHANGELOG.md Update changelog 4 years ago
LICENSE Bump Copyright, add contributors 5 years ago
README.md Update changelog and readme 5 years ago
build.xml tweak travis 5 years ago
composer.json Adopt fXSL as project is archived and we need to address a BC issue 3 years ago
composer.lock Update dependencies 3 years ago
phive.xml Update tools 5 years ago
phpcs.xml Indenting cleanup 3 -> 4 spaces, a first phpcs.xml to support code sniffer 13 years ago
phpdox Adopt fXSL as project is archived and we need to address a BC issue 3 years ago
phpdox.bat Bump Copyright to 2013 ;) 11 years ago
phpdox.xml.dist update documentation 10 years ago
phpunit.xml.dist Update tests 5 years ago

README.md

phpDox

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.

Build Status Scrutinizer Code Quality

Requirements

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