Skip to content
/ phpdox Public

Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT)

License

Notifications You must be signed in to change notification settings

theseer/phpdox

Folders and files

NameName
Last commit message
Last commit date
Nov 29, 2014
Jul 2, 2017
Jan 16, 2019
Sep 10, 2014
Apr 20, 2023
Oct 3, 2019
Mar 20, 2021
Jan 15, 2019
Jan 15, 2019
Dec 29, 2019
Apr 14, 2020
Jan 16, 2019
Jan 16, 2019
Jan 16, 2019
Mar 20, 2021
Mar 20, 2021
Mar 13, 2019
Apr 3, 2011
Mar 20, 2021
Aug 7, 2013
Jul 31, 2014
Jan 15, 2019

Repository files navigation

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.

Build Status Scrutinizer Code Quality

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:

phive install phpdox

You can now execute phpdox on the command line:

tools/phpdox --version

If everything worked out, you should get an output like this:

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"

Composer Installation

Additionally, phpDox can be installed via composer:

composer require --dev theseer/phpdox 

You can now execute phpdox on the command line:

vendor/bin/phpdox --version

If everything worked out, you should get an output like this:

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.

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

Usage Examples

You can run phpDox like this:

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

phpdox --skel > phpdox.xml.dist

Sample invocation to parse and generate output based on the default phpdox.xml configuration file

phpdox

or you can tell phpdox what configuration file to use by calling switch --file or in short

phpdox -f path/to/phpdox.xml

About

Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT)

Resources

License

Stars

Watchers

Forks

Packages

No packages published