About phpDocumentor
phpDocumentor is a documentation application for PHP projects. It reads your code and its DocBlock comments, then creates a documentation site with search and class diagrams.
What it does
The tool analyses PHP code, uses the information in DocBlocks to add detail, and writes a browsable documentation website. It can draw UML class diagrams with PlantUML or GraphViz, and its full-text search keeps working offline. It fits into a continuous integration pipeline through a GitHub Action or a Docker image.
Key features
- Reads PHP code and DocBlock comments
- UML class diagrams with PlantUML or GraphViz
- Full-text search that works offline
- Runs as a PHAR file or through Composer
- GitHub Action for documentation builds
Who it's for
PHP developers and teams that keep documentation close to the codebase. It is a good fit for projects that want the docs generated automatically on each change.
Pricing and good to know
The project is listed under the MIT license. You can download a PHAR file, add the shim package with Composer, or run the Docker image. According to its site, the project is open source and has no large funders, so it relies on its community. Your DocBlocks decide how much detail the output contains.
Highlights
- Reads PHP code and DocBlock comments
- Draws UML class diagrams from your project
- Offers full-text search that works offline
- Runs as a PHAR file, through Composer or Docker
- Fits into CI with a GitHub Action
