Skip to content
Documentation Generator for PHP
PHP JavaScript XSLT HTML CSS Gherkin Other
Branch: develop
Clone or download
Latest commit 501a467 Aug 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update issue workflow Aug 13, 2019
.travis Add secrets to sign phar Jun 26, 2018
bin Bin/console still contained deprecated Annotation loader Jun 14, 2019
config Split the parser stage in to pipeline Jul 31, 2019
data Make inclusion of sourcecode configurable Jun 15, 2019
docker/with-xdebug Fix docker build Jul 28, 2019
docs Refactored the Twig plugin into the main application Jun 14, 2019
src/phpDocumentor Remove zend-filter Jul 31, 2019
tests Fix version check tests Aug 10, 2019
tools Upgrade box Aug 11, 2019
.dockerignore Fixes phar building for symfony Jun 12, 2018
.env Initial effort to replace Cilex with Symfony4 Apr 27, 2018
.env.dist Initial effort to replace Cilex with Symfony4 Apr 27, 2018
.gitattributes Remove vagrant, improve docker flow and remove old build artefacts Jan 1, 2018
.gitignore Split the parser stage in to pipeline Jul 31, 2019
.scrutinizer.yml don't analyze phpstan Jan 11, 2018
.travis.yml Allow composer dump autoload Aug 11, 2019
CHANGELOG.md Introduce flysystem for parser source Dec 10, 2017
CONTRIBUTING.md Update test config to work for first timers Sep 2, 2018
Dockerfile Fix(Dockerfile): configure: error: Please reinstall the libzip distri… Jul 8, 2019
LICENSE add license name Jan 9, 2018
Makefile Introduce the first command in a Makefile Sep 21, 2018
README.md v3 needs PHP 7.1 or higher Feb 13, 2019
VERSION fixed version Feb 11, 2018
appveyor.yml limit composer version to stable Jul 30, 2018
behat.yml Attempt to fix travis test Feb 22, 2019
box.json Improve box config Aug 11, 2019
composer-require-config.json Add composer require checker Aug 11, 2018
composer.json Remove zend-filter Jul 31, 2019
composer.lock Remove zend-filter Jul 31, 2019
docker-compose.yml Fix code style according to psr2 Mar 14, 2019
phive.xml Add composer require checker Aug 11, 2018
phpcs.xml.dist Fix code style according to psr2 Mar 14, 2019
phpdoc.dist.xml Remove basic plugin support Jun 13, 2019
phpmd.xml.dist Fixing type inference and variable length issues Jul 31, 2014
phpstan.neon upgrade to custom phpstan image Aug 1, 2019
phpunit.xml.dist Update test config to work for first timers Sep 2, 2018
symfony.lock Remove zend-filter Jul 31, 2019

README.md

License: MIT Travis Status Appveyor Status Coveralls Coverage Scrutinizer Code Coverage Scrutinizer Code Quality Stable Version Unstable Version Downloads

phpDocumentor

What is phpDocumentor?

phpDocumentor is an application that is capable of analyzing your PHP source code and DocBlock comments to generate a complete set of API Documentation.

Inspired by phpDocumentor 1 and JavaDoc it continues to innovate and is up to date with the latest technologies and PHP language features.

Features

phpDocumentor supports the following:

  • PHP 7.0 compatible, full support for Namespaces, Closures and more is provided.
  • Shows any tag, some tags add additional functionality to phpDocumentor (such as @link).
  • Processing speed, Zend Framework experienced a significant reduction in processing time compared to phpDocumentor 1.
  • Low memory usage, peak memory usage for small projects is less than 20MB, medium projects 40MB and large frameworks 100MB.
  • Incremental parsing, if you kept the Structure file from a previous run you get an additional performance boost of up to 80% on top of the mentioned processing speed above.
  • Easy template building, if you want to make a branding you only have to call 1 task and edit 3 files.
  • Command-line compatibility with phpDocumentor 1, phpDocumentor 2 is an application in its own right but the basic phpDocumentor 1 arguments, such as --directory, --file and --target, have been adopted.
  • Two-step process, phpDocumentor first generates a cache with your application structure before creating the output. If you'd like you can use that to power your own tools or formatters!

Please note that phpDocumentor 3 is still under heavy development. We aim to add all features needed to have full support for php 7+. But at this moment that is not the case.

Requirements

phpDocumentor requires the following:

Note: If you do not want to install the Graphviz dependency you are encouraged to generate your own template and make sure that it does not contain anything related to Graph. An easier solution might be to edit data/templates/responsive/template.xml file and remove every line containing the word Graph but this will be undone with every upgrade of phpDocumentor.

Please see the documentation about creating your own templates for more information.

Installation

There are 3 ways to install phpDocumentor:

  1. Using the PHAR
  2. Via Docker
  3. Via Composer

Please note that it is required that the installation path of phpDocumentor does not contain spaces. This is a requirement imposed by an external library (libxml)

Using the PHAR

  1. Download the phar file from https://github.com/phpDocumentor/phpDocumentor2/releases
  2. ???
  3. Profit!

Via docker

  1. $ docker pull phpdoc/phpdoc
  2. $ docker run --rm -v $(pwd):/data phpdoc/phpdoc

Via Composer

  1. phpDocumentor is available on Packagist.

  2. It can be installed as a dependency of your project by running

     $ composer require --dev phpdocumentor/phpdocumentor dev-master
    

Afterwards you are able to run phpDocumentor directly from your vendor directory:

$ php vendor/bin/phpdoc

Please note that we are not able to be compatible with all types of setups. In some situations phpDocumentor will block updates of other packages. We do not recommend using composer to install phpDocumentor.

Pear

Starting from phpDocumentor v3 we decided to drop pear support. We will provide the already released versions of phpDocumentor v2. But these versions won't be maintained.

How to use phpDocumentor?

The easiest way to run phpDocumentor is by running the following command:

$ phpdoc run -d <SOURCE_DIRECTORY> -t <TARGET_DIRECTORY>

This command will parse the source code provided using the -d argument and output it to the folder indicated by the -t argument.

phpDocumentor supports a whole range of options to configure the output of your documentation. You can execute the following command, or check our website, for a more detailed listing of available command line options.

$ phpdoc run -h

Configuration file(s)

phpDocumentor also supports the use of configuration files (named phpdoc.xml or phpdoc.dist.xml by default). Please consult the documentation to see the format and supported options.

Documentation

For more detailed information you can check our online documentation at http://phpdoc.org/docs/latest/index.html.

Known issues

  1. phpDocumentor must be installed in a path without spaces due to restrictions in libxml. The XSL transformation will throw all kinds of odd warnings if the path contains spaces.

Contact

To come in contact is actually dead simple and can be done in a variety of ways.

You can’t perform that action at this time.