- Home
- Documentation Generators
- phpDocumentor
phpDocumentor
What it is
phpDocumentor is a free, open-source tool that analyzes PHP source code and DocBlock comments to create API documentation. It can generate UML diagrams for visualizing code structure, parse both Markdown and reStructuredText, and place API documentation sections inside reStructuredText material. The product site says full-text search works offline and describes CI integration through a GitHub Action or Docker image. Installation options include Docker, Phive, and a PHAR download. Standalone use requires PHP 8.1.2 or newer plus the mbstring extension; PlantUML is optional. The official Docker image bundles dependencies. The project also provides Composer-installable components for parsing, rendering, type resolution, and reflection. It supports Linux and macOS in self-hosted setups. The Docker Hub overview cautions that direct Composer installation is not actively supported because dependency conflicts may occur.
For and against
For
- Generates API documentation from PHP code
- Creates UML diagrams of code structure
- Supports Markdown and reStructuredText
- Offers Docker and PHAR installation
- Offline full-text search is described
Against
- Requires PHP 8.1.2 and mbstring standalone
- Direct Composer installation is not actively supported
The verdict
phpDocumentor provides a free, self-hosted workflow for PHP documentation and diagrams. Docker, PHAR, and CI options support different installation and automation needs.
Who it suits
phpDocumentor suits PHP developers maintaining generated API references and code-linked documentation. It is useful for teams integrating documentation generation into CI pipelines.
Plans and prices
phpDocumentor
Open-source PHP documentation tool; no paid plans listed on the opened official pages
Read 8 Oct 2026 · phpdoc.org
On the record
- CI
- The product site says it can be integrated into CI pipelines using its GitHub Action or Docker image.phpdoc.org · read 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 · read 8 Oct 2026
- Diagrams
- It can create UML diagrams to visualize code structure.docs.phpdoc.org · read 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 · read 8 Oct 2026
- Docker
- The official Docker image includes dependencies so they do not need to be installed locally.docs.phpdoc.org · read 8 Oct 2026
- Funding
- The site describes phpDocumentor as an open-source project without large funders and invites sponsorship through GitHub Sponsors.phpdoc.org · read 8 Oct 2026
- Install options
- The documentation recommends Docker, Phive, or downloading the PHAR file.docs.phpdoc.org · read 8 Oct 2026
- Markup
- Its markup parser supports RestructuredText and Markdown.docs.phpdoc.org · read 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 · read 8 Oct 2026
- Purpose
- phpDocumentor analyzes PHP source code and DocBlock comments to generate API documentation.docs.phpdoc.org · read 8 Oct 2026
- Runtime requirements
- Standalone installation requires PHP 8.1.2 or higher and the mbstring extension; PlantUML is optional.docs.phpdoc.org · read 8 Oct 2026
- Search
- The product site says full-text search works even offline.phpdoc.org · read 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 · read 8 Oct 2026
