PHPDoctor is an attempt to create a simpler and faster PHPDoc (Javadoc style comment parser for PHP) that produces standards compliant HTML.
It is designed with an emphasis on speed and simplicity, meaning it is not as fully featured as the PEAR PHPDoc program, but is simple to configure, use, and extend, and should be able to generate API documentation from your existing un-edited PHP code in only a few minutes.
We are looking for people to help test the latest release candidate by running it against as much PHP code as possible. Read this if you want to help.
You can also clone the project with Git by running:
git clone git://github.com/peej/phpdoctor
Once you're ready, read the installation instructions.
PHP 4.3.0+ is required due to use of the PHP tokenizer extension. The tokenizer is built into PHP 4.3.0 by default, PHPDoctor may work with older versions of PHP with the tokenizer extension enabled but it has not been tested and you are recommended to upgrade to 4.3.0+ for using this program.
- Fast running speed, uses PHP 4.3 tokeniser function to take advantage of PHPs internal parsing functionality.
- Parsing of any PHP file, with multiple classes and functions in the same file.
- Simple output template layer, allowing easy changing of the output format by copying and editing of a few simple PHP template files.
- Simple to install and use, instant results.
- Will generates API documentation bare bones without Javadoc comments present.
- Works with both OO and procedural code, also documents global variables and constants.
- Supports PHP5 enhanced syntax, including interfaces.
- Minimal changes to Sun's Javadoc specification.
- Changes to tags compatible with other PHPDoc programs.
- Did I say it was fast?
Below are two examples of PHPDoctor generated API documentation. The first is documentation of PHPDoctor itself, the second of the popular Smarty templating engine.
- PHPDoctor API documentation
- Smarty API documentation
- GeSHi API documentation
- SimpleTest API documentation
You can generate the PHPDoctor documentation for yourself, simply run PHPDoctor with the default.ini config file supplied in the archive.