phpDocumentor

Because
code and documentation
are meant to be together.

phpDocumentor is the de-facto documentation application for PHP projects. Your project can benefit too from more than 20 years of experience and setting the standard for documenting PHP Applications.

Documentation

FeaturesWhat can phpDocumentor 3 do to help you with your documentation

Screenshot of what the output looks like

  • Super easy to install and use

    Thanks to the power of Docker or PHAR

  • Creates Beautiful Documentation

    Learns everything about your code and uses that to make sure you have the best documentation.

  • UML Class Diagrams

    Gives you a UML Class Diagram for your project using PlantUML or GraphViz.

  • Supports PHP latest

    Supports the latest features that PHP has to offer.

  • More control using DocBlocks

    Uses the information from your DocBlocks to provide even more insight.

  • Full-Text Search

    Need to find that one method? Full-text search is supported, even offline.

  • CI Support out of the box

    Integrate it into your CI pipeline with our Github Action or Docker image

UsageEasy to install, and to use!

Getting started using the PHAR

Start by downloading our latest PHAR file and giving it a nice and cozy place on your hard drive. 

$ wget https://phpdoc.org/phpDocumentor.phar

After you downloaded the PHAR file, don't forget to power it up by making it executable. 

$ chmod +x phpDocumentor.phar
Also, you may want to consider renaming it to phpdoc; we'll understand.

Then, all you need to do is run it!

Getting started using Docker

Use our very own Docker image; no installation needed!

Treat our docker image like you treat all your other utility images. Just don't forgot to volume mount your current directory to /data inside the container. Remember: No data, No docs. 

$ docker run --rm -v ${PWD}:/data phpdoc/phpdoc:3

Tada!

Using Composer

If you are using Composer to manage your project dependencies, you can also add phpDocumentor as a development dependency using our shim package. This will make sure you never have conflicts with other packages. 

$ composer require --dev phpdocumentor/shim
$ ./vendor/bin/phpdoc
Learn more

Sponsors

phpDocumentor is an opensource project without any large funders. If you use this project we would love to receive your support via GitHub Sponsors. Your sponsorship will help us to keep the project alive.

Our sponsors:

  • Nexaa logo
  • PhpStorm logo
  • Ingewikkeld logo