Documentation Generator for PHP
PHP JavaScript XSLT HTML CSS Gherkin
Latest commit 4c13b1d Oct 12, 2017 @UziTech UziTech committed with jaapio Fix menu always hidden
The first argument to .filter is the index
Permalink
Failed to load latest commit information.
ansible Phar should be copied from right location Oct 29, 2014
bin fix all kind of white space errors Aug 30, 2014
data Fix menu always hidden Oct 15, 2017
docs explain that @see tags cannot be used for namespace elements Oct 4, 2017
features rename file containing : which is causing issues on windows Dec 2, 2015
src Fixes php 7.2 compatiblity Oct 10, 2017
tests Upgrades all dependencies Oct 11, 2017
.dockerignore Add Composer to the Docker build process for Docker Hub May 14, 2017
.gitattributes gitignore: ignore unused files [closes #1529] Jun 15, 2015
.gitignore tweaking gitignore to cover windows bin files Aug 12, 2017
.scrutinizer.yml Upgrades all dependencies Oct 11, 2017
.travis.yml Upgrades all dependencies Oct 11, 2017
CHANGELOG.md Update changelog Nov 26, 2014
CONTRIBUTING.md update contribution to inform people about different versions Dec 13, 2015
Dockerfile Add Composer to the Docker build process for Docker Hub May 14, 2017
LICENSE Added parameter for setting the desired output format for transformat… Oct 6, 2010
README.md Adds ci badges May 29, 2017
VERSION change version into 2.9.1 May 26, 2016
Vagrantfile Ansible for windows users Jul 22, 2014
appveyor.yml remove php5 builds Sep 15, 2017
behat.yml Small fixes in behat tests Sep 13, 2017
box.json Fixes dependencies in box May 22, 2016
box.phar Add deployment rules to Travis May 19, 2017
build.xml Remove non existing no-paths option Aug 21, 2017
composer.json Upgrades all dependencies Oct 11, 2017
composer.lock Upgrades all dependencies Oct 11, 2017
package.xml Commit package file for 2.3.1 Feb 26, 2014
phpdoc.dist.xml Adds support for new Reflection component Sep 13, 2017
phpmd.xml.dist Fixing type inference and variable length issues Jul 31, 2014
phpunit.xml.dist Upgrades all dependencies Oct 11, 2017

README.md

Build Status Build status Code Coverage Scrutinizer Code Quality

README

What is phpDocumentor?

phpDocumentor 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 5.3 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!

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. Via PEAR (recommended)
  2. Via Composer
  3. Using the PHAR

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)

PEAR (recommended)

  1. phpDocumentor is hosted on its own PEAR channel which can be discovered using the following command:

     $ pear channel-discover pear.phpdoc.org
    
  2. After that it is a simple matter of invoking PEAR to install the application

     $ pear install phpdoc/phpDocumentor
    

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

Using the PHAR

  1. Download the phar file from http://phpdoc.org/phpDocumentor.phar
  2. ???
  3. Profit!

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.

Donations

If you would like to help out financially we accept donations using gittip. All donations will be used to cover the costs for hosting phpDocumentor's website and PEAR repository.

Contact

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