2017 © Pedro Peláez
 

library phpdox

A fast Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT) with event based processing

image

theseer/phpdox

A fast Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT) with event based processing

  • Sunday, June 3, 2018
  • by theseer
  • Repository
  • 32 Watchers
  • 446 Stars
  • 834,124 Installations
  • PHP
  • 160 Dependents
  • 6 Suggesters
  • 102 Forks
  • 23 Open issues
  • 20 Versions
  • 6 % Grown

The README.md

phpDox

phpDox is a documentation generator for PHP projects. This includes, but is not limited to, API documentation. The main focus is on enriching the generated documentation with additional details like code coverage, complexity information and more., (*1)

Build Status Scrutinizer Code Quality, (*2)

Requirements

Phar Installation

phpDox is shipping as a selfcontained executable phar archive. You can grab your copy from the releases section or install using phive:, (*3)

phive install phpdox

You can now execute phpdox on the command line:, (*4)

tools/phpdox --version

If everything worked out, you should get an output like this:, (*5)

phpDox 0.11.2 - Copyright (C) 2010 - 2018 by Arne Blankerts and Contributors

Note: Some Linux distributions ship PHP with ext/suhosin and disabled phar execution. To make use of phpDox in such an environment, you need to enable phar execution by adding phar to the executor white list: suhosin.executor.include.whitelist="phar", (*6)

Composer Installation

Additionally, phpDox can be installed via composer:, (*7)

composer require --dev theseer/phpdox 

You can now execute phpdox on the command line:, (*8)

vendor/bin/phpdox --version

If everything worked out, you should get an output like this:, (*9)

phpDox 0.11.2 - Copyright (C) 2010 - 2018 by Arne Blankerts and Contributors

Developer Installation

In case you want to go bleeding edge or hack on the source, you will have to clone this repository., (*10)

git clone git://github.com/theseer/phpdox.git
composer install

Usage Examples

You can run phpDox like this:, (*11)

phpdox --help

As of version 0.4 phpDox requires an xml configuration file. In case a project you want to generate documentation for does not come with one, you can create it by calling, (*12)

phpdox --skel > phpdox.xml.dist

Sample invocation to parse and generate output based on the default phpdox.xml configuration file, (*13)

phpdox

or you can tell phpdox what configuration file to use by calling switch --file or in short, (*14)

phpdox -f path/to/phpdox.xml

The Versions

03/06 2018

dev-master

9999999-dev

A fast Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT) with event based processing

  Sources   Download

BSD-3-Clause

The Requires

 

by Arne Blankerts

22/05 2018

0.11.2

0.11.2.0

A fast Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT) with event based processing

  Sources   Download

BSD-3-Clause

The Requires

 

by Arne Blankerts

07/05 2018

0.11.1

0.11.1.0

A fast Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT) with event based processing

  Sources   Download

BSD-3-Clause

The Requires

 

by Arne Blankerts

10/01 2018

0.11.0

0.11.0.0

A fast Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT) with event based processing

  Sources   Download

BSD-3-Clause

The Requires

 

by Arne Blankerts

02/07 2017

0.10.1

0.10.1.0

A fast Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT) with event based processing

  Sources   Download

BSD-3-Clause

The Requires

 

by Arne Blankerts

16/06 2017

0.10.0

0.10.0.0

A fast Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT) with event based processing

  Sources   Download

BSD-3-Clause

The Requires

 

by Arne Blankerts

26/08 2016

0.9.0

0.9.0.0

A fast Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT) with event based processing

  Sources   Download

BSD-3-Clause

The Requires

 

by Arne Blankerts

09/07 2015

0.8.1.1

0.8.1.1

A fast Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT) with event based processing

  Sources   Download

BSD-3-Clause

The Requires

 

by Arne Blankerts

30/06 2015

0.8.1

0.8.1.0

A fast Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT) with event based processing

  Sources   Download

BSD-3-Clause

The Requires

 

by Arne Blankerts

06/05 2015

0.8.0

0.8.0.0

A fast Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT) with event based processing

  Sources   Download

BSD-3-Clause

The Requires

 

by Arne Blankerts

11/09 2014

0.7.0

0.7.0.0

A fast Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT) with event based processing

  Sources   Download

BSD-3-Clause

The Requires

 

by Arne Blankerts

04/05 2014

0.6.6.1

0.6.6.1

A fast Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT) with event based processing

  Sources   Download

BSD-3-Clause

The Requires

 

by Arne Blankerts

04/05 2014

0.6.6

0.6.6.0

A fast Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT) with event based processing

  Sources   Download

BSD-3-Clause

The Requires

 

by Arne Blankerts

17/02 2014

0.6.5

0.6.5.0

A fast Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT) with event based processing

  Sources   Download

BSD-3-Clause

The Requires

 

by Arne Blankerts

17/02 2014

0.6.4.1

0.6.4.1

A fast Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT) with event based processing

  Sources   Download

BSD-3-Clause

The Requires

 

by Arne Blankerts

17/02 2014

0.6.4

0.6.4.0

A fast Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT) with event based processing

  Sources   Download

BSD-3-Clause

The Requires

 

by Arne Blankerts

08/01 2014

0.6.3

0.6.3.0

A fast Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT) with event based processing

  Sources   Download

BSD-3-Clause

The Requires

 

by Arne Blankerts

19/12 2013

0.6.2

0.6.2.0

A fast Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT) with event based processing

  Sources   Download

BSD-3-Clause

The Requires

 

by Arne Blankerts

19/12 2013

0.6.1

0.6.1.0

A fast Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT) with event based processing

  Sources   Download

BSD-3-Clause

The Requires

 

by Arne Blankerts

03/12 2013

0.6

0.6.0.0

A fast Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT) with event based processing

  Sources   Download

BSD-3-Clause

The Requires

 

by Arne Blankerts