phpDocumentor – analyzes your code to create great documentation

phpDocumentor, sometimes referred to as phpdoc or phpdocu, is the current standard auto-documentation tool for the PHP language.

Similar to Javadoc, phpDocumentor can be used from the command line or a web interface to create professional documentation from PHP source code.

phpDocumentor has support for linking between documentation, incorporating user level documents like tutorials and creation of highlighted source code with cross referencing to PHP general documentation. It supports all Javadoc tags, including inline links, and also supports PHPdoc documentation in PEAR style.

Features include:

  • Very fast.
  • Output generated in HTML, PDF (directly), CHM (with windows help compiler), XML DocBook.
  • Web and command-line interface.
  • Fully customizable output with Smarty-based templates.
  • Recognizes JavaDoc-style documentation with special tags customized for PHP 4.
  • Automatic linking, class inheritance diagrams and intelligent override.
  • Customizable source code highlighting, with phpxref-style cross-referencing.
  • Parses standard README/CHANGELOG/INSTALL/FAQ files and includes them directly in documentation.
  • Generates a todo list from @todo tags in source.
  • Generates multiple documentation sets based on @access private, @internal and {@internal} tags.
  • Example php files can be placed directly in documentation with highlighting and phpxref linking using the @example tag.
  • Linking between external manual and API documentation is possible at the sub-section level in all output formats.
  • Easily extended for specific documentation needs with Converter.
  • Full documentation of every feature, manual can be generated directly from the source code with “phpdoc -c makedocs” in any format desired.
  • Current manual always available at https://www.phpdoc.org/manual.php.
  • User .ini files can be used to control output, multiple outputs can be generated at once.

Website: www.phpdoc.org
Support: GitHub
Developer: Joshua Eichorn, Kellin, Juan Pablo Morales, Florian Clever, Dennis Kehrig, and many others
License: GNU GPL v2

phpDocumentor is written in PHP. Learn PHP with our recommended free books and free tutorials.

Return to Documentation Generators Home Page

Want to find more awesome open source software? Check out our award winning open source software directory featuring more than 20,000 open source apps.
Share this article

Share your Thoughts

This site uses Akismet to reduce spam. Learn how your comment data is processed.