Description
phpDox is shipping as a selfcontained executable phar archive. You can grab your copy from the releases section or directly here:
phpDox alternatives and similar libraries
Based on the "Documentation" category.
Alternatively, view phpDox alternatives based on common mentions on social networks and blogs.
-
HumHub
HumHub is an Open Source Enterprise Social Network. Easy to install, intuitive to use and extendable with countless freely available modules. -
-
-
daux.io
Daux.io is an documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way. -
-
-
-
-
Doctum, a PHP API documentation generator. Fork of Sami
A php API documentation generator, fork of Sami -
allourideas.org
allourideas allows groups to collect and priorize information in an open, democratic, and efficient process. -
Agouti
A platform for collective blogs and social media platform, forum, question and answer service (Q&A). A community based on the PHP HLEB micro-framework. -
php-docbloc
Create and keep updated docBlock of your project files fetching details from composer.json and Git. Supported filetypes: *.php, *.ini, *.sh, *.bat, *.md (No Composer or PEAR need to be installed to use this tool).
InfluxDB – Built for High-Performance Time Series Workloads
* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest.
Do you think we are missing an alternative of phpDox or a related project?
README
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.
Requirements
- PHP Version 7.1+ (For PHP 5.5+, use phpDox 0.11.2)
- ext/dom
- ext/xsl
- ext/iconv and libiconv version >= 2.12
- PHPParser PHP Parser API
- fDOMDocument
- DirectoryScanner
- fXSL
- PHP_Timer
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