phpDox

phpDox is a documentation generator for generating API documentation in HTML format, for instance, from PHP source code.

Requirements

• PHP Version 5.3.3+
  • ext/dom
  • ext/xsl
  • ext/iconv and libiconv version >= 2.12
• PHPParser PHP Parser API
• fDOMDocument
• DirectoryScanner
• fXSL
• PHP_Timer

User Installation

phpDox is shipping as a selfcontained executable phar archive. You can grab your copy here:

• Release 0.7.0

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:

phpdox --version

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"

Developer Installation

In case you want to go bleeding edge or hack on the source, you will have to clone this repository.

Note: The 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

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

Changelog

#####Release 0.7.0

• Fix: Set default resolution of ${basename} to dirname of realpath of config file instead of only relative dir
• Fix: Crash on invalid encoding / control chars in source (Issue #146, #148)
• Fix: Crash on empty namespace name (Issue #150)
• Fix: Broken cache handling for files that no longer exist (Issue #149)
• Fix: DocBlock parsing generates invalid tag names in xml in some cases (Thanks to Reno Reckling)
• Fix: Crash on custom bootstrapping (Thanks to Sebastian Heuer)
• Updated Templates
• Added tokenizer xml and highlighted source output
• Added support for native PHPCS xml format (Thanks to Reno Reckling)
• Removed dependency to Zeta Components by own (simplified) implementation
• Unified xml namespace uri format by stripping the # where it was still in place
• Minor performance tweaks

#####Release 0.6.6.1 (composer only)

• Fix: Issue with composer based installs

#####Release 0.6.6

• Updated Dependencies (DirectoryScanner to 1.3.0, PHPParser to 1.0.0, fDOMDocument to 1.5.0)
• Internal Adjustments for updated Dependencies and API Changes
• Enhanced HTML Output for Parameter lists
• Refactored @inheritdoc support
• Better Windows support (Thanks to Thomas Weinert)
• Added XSD for phpdox.xml config file (Thanks to Thomas Weinert)
• Enhanced PHPUnit enricher to not claim empty classes are untested

#####Older Releases

• Please refer to the git history for now.