phpDocumentor
phpdoc.org
- Free plan
- macOS
- Linux
- Self-hosted
What phpDocumentor is
phpDocumentor analyzes PHP source files and DocBlock comments to produce API documentation. It can also create UML diagrams of code structure, and its markup parser handles Markdown and reStructuredText. Parts of API documentation can be placed directly in reStructuredText material. The product site says full-text search works offline and describes CI integration through a GitHub Action or Docker image. The tool is free and open source, with Linux, macOS, and self-hosted use listed. Installation guidance recommends Docker, Phive, or a PHAR download. A standalone installation needs PHP 8.1.2 or higher and the mbstring extension; PlantUML is optional. The official Docker image includes dependencies, so they do not need to be installed locally. Separate Composer-installable components are available for parsing and rendering documentation, resolving types, and reflecting on PHP files and projects. The project invites sponsorship through GitHub Sponsors. Its Docker Hub overview says direct Composer installation is not endorsed or actively supported because of dependency conflict risk.
Who it suits
It suits PHP developers who want to generate API documentation from code comments and integrate documentation work into CI pipelines. Teams considering direct Composer installation should note that this method is not actively supported by the project.
Good to know, and what to watch
- Generates API documentation from PHP and DocBlock comments
- Creates UML diagrams of code structure
- Supports Markdown and reStructuredText
- Full-text search works offline
- Docker image includes required dependencies
- Standalone installation requires PHP 8.1.2 or higher
- Standalone installation requires the mbstring extension
- Direct Composer installation is not actively supported
Plans
Every plan and pricephpDocumentor
Open source
The verdict
phpDocumentor offers a free, self-hosted way to generate and search PHP API documentation, with CI options and several installation routes. Docker, Phive, or the PHAR are the documented installation choices; direct Composer installation carries a stated dependency conflict concern.
What the maker publishes
- CI
- The product site says it can be integrated into CI pipelines using its GitHub Action or Docker image. source
- Components
- The project offers standalone Composer-installable components for parsing and rendering documentation, resolving types, and reflecting on PHP files and projects. source
- Diagrams
- It can create UML diagrams to visualize code structure. source
- Doc integration
- It can include parts of API documentation directly in RestructuredText documentation to keep docs and code in sync. source
- Docker
- The official Docker image includes dependencies so they do not need to be installed locally. source
- Funding
- The site describes phpDocumentor as an open-source project without large funders and invites sponsorship through GitHub Sponsors. source
- Install options
- The documentation recommends Docker, Phive, or downloading the PHAR file. source
- Markup
- Its markup parser supports RestructuredText and Markdown. source
- Platform use
- The installation guide documents PHAR execution on Mac and Linux and also recommends Docker for standalone use. source
- Purpose
- phpDocumentor analyzes PHP source code and DocBlock comments to generate API documentation. source
- Runtime requirements
- Standalone installation requires PHP 8.1.2 or higher and the mbstring extension; PlantUML is optional. source
- Search
- The product site says full-text search works even offline. source
- Support status
- The Docker Hub overview says phpDocumentor does not endorse or actively support installing the application directly through Composer, citing dependency conflict risk. source
Checked against the maker's pages on 8 Oct 2026.