Freedom251 › Documentation Generators
phpDocumentor
What phpDocumentor is
phpDocumentor analyzes PHP source code and DocBlock comments to produce API documentation. It can also generate UML diagrams to make code structure visible. The markup parser handles Markdown and reStructuredText, and parts of API documentation can be placed directly in reStructuredText documents. The product site says full-text search can work offline and describes CI integration through a GitHub Action or Docker image. Installation options recommended in the documentation include Docker, Phive, and the PHAR file. A standalone installation requires PHP 8.1.2 or higher and the mbstring extension; PlantUML is optional. The official Docker image includes dependencies, avoiding the need to install them locally. The project also offers standalone Composer-installable components for parsing and rendering documentation, resolving types, and reflecting on PHP files and projects. phpDocumentor is free and open source, with a self-hosted model and documented PHAR use on Mac and Linux. Its Docker Hub overview says direct Composer installation is not endorsed or actively supported because of potential dependency conflicts. The project invites sponsorship through GitHub Sponsors.
Who it suits
phpDocumentor suits PHP developers who want to generate API documentation from source and DocBlock comments. It may also fit teams that need documentation generation in a CI pipeline or prefer a self-hosted tool.
What it does well
- Generates API documentation from PHP code and DocBlocks.
- Can create UML diagrams of code structure.
- Supports Markdown and reStructuredText.
- Offers CI integration through a GitHub Action or Docker image.
- Free and open source.
What to know first
- Standalone installation requires PHP 8.1.2 or higher.
- Standalone installation requires the mbstring extension.
- Direct Composer installation is not actively supported.
Limits
Standalone installation requires PHP 8.1.2 or higher and mbstring; PlantUML is optional.
Plans
| Plan | Billed and limits | Price |
|---|---|---|
| phpDocumentor | Open-source PHP documentation tool; no paid plans listed on the opened official pages | Free |
As phpdoc.org lists them, read 8 Oct 2026. The maker's own page has the final word.
Getting started
- Visit phpDocumentor’s website.
- Choose Docker, Phive, or the PHAR file as an installation route.
- For standalone installation, use PHP 8.1.2 or higher and the mbstring extension; PlantUML is optional.
- Run phpDocumentor against PHP source code and DocBlock comments to generate API documentation.
- For CI integration, use the documented GitHub Action or Docker image.
Verdict
phpDocumentor offers a free, self-hosted route to PHP API documentation, with diagrams, markup support, and CI options. Choose an installation method with its runtime requirements in mind, especially since direct Composer installation is not actively supported.
Questions
Is phpDocumentor free?
Yes. The listed plan is free, and phpDocumentor is open source.
What does phpDocumentor generate?
It analyzes PHP source code and DocBlock comments to generate API documentation. It can also create UML diagrams of code structure.
Which platforms are supported?
The listed platforms are Linux, macOS, and self-hosted. The installation guide documents PHAR execution on Mac and Linux and recommends Docker for standalone use.
What are the installation options?
The documentation recommends Docker, Phive, or downloading the PHAR file. The project says it does not endorse or actively support direct Composer installation of the application because of dependency conflict risk.
Does it work offline?
The product site says its full-text search works offline.
Does phpDocumentor offer paid support?
The project invites sponsorship through GitHub Sponsors.
Facts from phpDocumentor's own pages
- CI
- The product site says it can be integrated into CI pipelines using its GitHub Action or Docker image. · phpdoc.org, 8 Oct 2026
- Components
- The project offers standalone Composer-installable components for parsing and rendering documentation, resolving types, and reflecting on PHP files and projects. · phpdoc.org, 8 Oct 2026
- Diagrams
- It can create UML diagrams to visualize code structure. · docs.phpdoc.org, 8 Oct 2026
- Doc integration
- It can include parts of API documentation directly in RestructuredText documentation to keep docs and code in sync. · docs.phpdoc.org, 8 Oct 2026
- Docker
- The official Docker image includes dependencies so they do not need to be installed locally. · docs.phpdoc.org, 8 Oct 2026
- Funding
- The site describes phpDocumentor as an open-source project without large funders and invites sponsorship through GitHub Sponsors. · phpdoc.org, 8 Oct 2026
- Install options
- The documentation recommends Docker, Phive, or downloading the PHAR file. · docs.phpdoc.org, 8 Oct 2026
- Markup
- Its markup parser supports RestructuredText and Markdown. · docs.phpdoc.org, 8 Oct 2026
- Platform use
- The installation guide documents PHAR execution on Mac and Linux and also recommends Docker for standalone use. · docs.phpdoc.org, 8 Oct 2026
- Purpose
- phpDocumentor analyzes PHP source code and DocBlock comments to generate API documentation. · docs.phpdoc.org, 8 Oct 2026
- Runtime requirements
- Standalone installation requires PHP 8.1.2 or higher and the mbstring extension; PlantUML is optional. · docs.phpdoc.org, 8 Oct 2026
- Search
- The product site says full-text search works even offline. · phpdoc.org, 8 Oct 2026
- Support status
- The Docker Hub overview says phpDocumentor does not endorse or actively support installing the application directly through Composer, citing dependency conflict risk. · hub.docker.com, 8 Oct 2026
Where phpDocumentor stands on Freedom251
- Documentation Generators#11 of 37
- API Documentation Tools#9 of 27