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: phpdoc.org
Support: GitHub Code Repository
Developer: Joshua Eichorn, Kellin, Juan Pablo Morales, Florian Clever, Dennis Kehrig, and many others
License: MIT License
phpDocumentor is written in PHP. Learn PHP with our recommended free books and free tutorials.
Return to Documentation Generators
| Popular series | |
|---|---|
 | The largest compilation of the best free and open source software in the universe. Each article is supplied with a legendary ratings chart helping you to make informed decisions. |
 | Hundreds of in-depth reviews offering our unbiased and expert opinion on software. We offer helpful and impartial information. |
 | The Big List of Active Linux Distros is a large compilation of actively developed Linux distributions. |
 | Replace proprietary software with open source alternatives: Google, Microsoft, Apple, Adobe, IBM, Autodesk, Oracle, Atlassian, Corel, Cisco, Intuit, and SAS. |
 | Awesome Free Linux Games Tools showcases a series of tools that making gaming on Linux a more pleasurable experience. This is a new series. |
 | Machine Learning explores practical applications of machine learning and deep learning from a Linux perspective. We've written reviews of more than 40 self-hosted apps. All are free and open source. |
 | New to Linux? Read our Linux for Starters series. We start right at the basics and teach you everything you need to know to get started with Linux. |
 | Alternatives to popular CLI tools showcases essential tools that are modern replacements for core Linux utilities. |
 | Essential Linux system tools focuses on small, indispensable utilities, useful for system administrators as well as regular users. |
 | Linux utilities to maximise your productivity. Small, indispensable tools, useful for anyone running a Linux machine. |
 | Surveys popular streaming services from a Linux perspective: Amazon Music Unlimited, Myuzi, Spotify, Deezer, Tidal. |
 | Saving Money with Linux looks at how you can reduce your energy bills running Linux. |
 | Home computers became commonplace in the 1980s. Emulate home computers including the Commodore 64, Amiga, Atari ST, ZX81, Amstrad CPC, and ZX Spectrum. |
 | Now and Then examines how promising open source software fared over the years. It can be a bumpy ride. |
 | Linux at Home looks at a range of home activities where Linux can play its part, making the most of our time at home, keeping active and engaged. |
 | Linux Candy reveals the lighter side of Linux. Have some fun and escape from the daily drudgery. |
 | Getting Started with Docker helps you master Docker, a set of platform as a service products that delivers software in packages called containers. |
 | Best Free Android Apps. We showcase free Android apps that are definitely worth downloading. There's a strict eligibility criteria for inclusion in this series. |
 | These best free books accelerate your learning of every programming language. Learn a new language today! |
 | These free tutorials offer the perfect tonic to our free programming books series. |
 | Linux Around The World showcases usergroups that are relevant to Linux enthusiasts. Great ways to meet up with fellow enthusiasts. |
 | Stars and Stripes is an occasional series looking at the impact of Linux in the USA. |