PHPackages theseer/phpdox - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. theseer/phpdox ActiveLibrary[Utility & Helpers](/categories/utility) theseer/phpdox ============== A fast Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT) with event based processing 0.12.0(7y ago)6012.4M—6.6%122[47 issues](https://github.com/theseer/phpdox/issues)[4 PRs](https://github.com/theseer/phpdox/pulls)20BSD-3-ClausePHPPHP >=7.1 Since Dec 3Pushed 3y ago24 watchersCompare [ Source](https://github.com/theseer/phpdox)[ Packagist](https://packagist.org/packages/theseer/phpdox)[ RSS](/packages/theseer-phpdox/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (10)Dependencies (5)Versions (22)Used By (20) phpDox ====== [](#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](https://camo.githubusercontent.com/a9ced0b56a0c785674dcd06606930701ee968cffd9873d1a3596a9f418e6619d/68747470733a2f2f7472617669732d63692e6f72672f746865736565722f706870646f782e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/theseer/phpdox)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/2d2ad1b52975ac6c1fa3a86b08cad8fd9be39c39eac17f6f296be94da06f484c/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f746865736565722f706870646f782f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/theseer/phpdox/?branch=master) Requirements ------------ [](#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](http://www.gnu.org/software/libiconv/documentation/libiconv/iconv.1.html) - PHPParser [PHP Parser API](https://github.com/nikic/PHP-Parser) - [fDOMDocument](http://github.com/theseer/fDOMDocument) - [DirectoryScanner](http://github.com/theseer/DirectoryScanner) - [fXSL](http://github.com/theseer/fXSL) - [PHP\_Timer](http://github.com/sebastianbergmann/php-timer) Phar Installation ----------------- [](#phar-installation) phpDox is shipping as a selfcontained executable phar archive. You can grab your copy from the [releases](https://github.com/theseer/phpdox/releases/latest) section or install using [phive](https://phar.io): ``` 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 --------------------- [](#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 ---------------------- [](#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 -------------- [](#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 ``` ### Health Score 48 — FairBetter than 94% of packages Maintenance18 Infrequent updates — may be unmaintained Popularity63 Solid adoption and visibility Community50 Growing community involvement Maturity57 Maturing project, gaining track record Bus Factor1 Top contributor holds 87.7% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~101 days Recently: every ~154 days Total 20 Last Release 2623d ago PHP version history (4 changes)0.6PHP >=5.3.3 0.9.0PHP >=5.4 0.10.0PHP >=5.5 0.12.0PHP >=7.1 ### Community Maintainers ![](https://www.gravatar.com/avatar/0fc8fe1ac311fb26137cc3b26cd6c1bbb58c9ac4f287eb9d8242a741cef9a502?d=identicon)[theseer](/maintainers/theseer) --- Top Contributors [![theseer](https://avatars.githubusercontent.com/u/111333?v=4)](https://github.com/theseer "theseer (929 commits)")[![lapistano](https://avatars.githubusercontent.com/u/95115?v=4)](https://github.com/lapistano "lapistano (56 commits)")[![eriksencosta](https://avatars.githubusercontent.com/u/16807915?v=4)](https://github.com/eriksencosta "eriksencosta (7 commits)")[![MacFJA](https://avatars.githubusercontent.com/u/1475671?v=4)](https://github.com/MacFJA "MacFJA (7 commits)")[![sebastianbergmann](https://avatars.githubusercontent.com/u/25218?v=4)](https://github.com/sebastianbergmann "sebastianbergmann (6 commits)")[![ThomasWeinert](https://avatars.githubusercontent.com/u/236825?v=4)](https://github.com/ThomasWeinert "ThomasWeinert (6 commits)")[![covex-nn](https://avatars.githubusercontent.com/u/110878?v=4)](https://github.com/covex-nn "covex-nn (5 commits)")[![yethee](https://avatars.githubusercontent.com/u/559488?v=4)](https://github.com/yethee "yethee (5 commits)")[![Qusonann](https://avatars.githubusercontent.com/u/58689118?v=4)](https://github.com/Qusonann "Qusonann (4 commits)")[![edorian](https://avatars.githubusercontent.com/u/247397?v=4)](https://github.com/edorian "edorian (3 commits)")[![xiian](https://avatars.githubusercontent.com/u/133872?v=4)](https://github.com/xiian "xiian (3 commits)")[![LouisLandry](https://avatars.githubusercontent.com/u/698255?v=4)](https://github.com/LouisLandry "LouisLandry (2 commits)")[![Eternal-Infinity](https://avatars.githubusercontent.com/u/5830244?v=4)](https://github.com/Eternal-Infinity "Eternal-Infinity (2 commits)")[![FMaz008](https://avatars.githubusercontent.com/u/525000?v=4)](https://github.com/FMaz008 "FMaz008 (2 commits)")[![homerjsimpson000](https://avatars.githubusercontent.com/u/15713189?v=4)](https://github.com/homerjsimpson000 "homerjsimpson000 (2 commits)")[![jasonhofer](https://avatars.githubusercontent.com/u/974242?v=4)](https://github.com/jasonhofer "jasonhofer (2 commits)")[![redbeardcreator](https://avatars.githubusercontent.com/u/375927?v=4)](https://github.com/redbeardcreator "redbeardcreator (2 commits)")[![remicollet](https://avatars.githubusercontent.com/u/270445?v=4)](https://github.com/remicollet "remicollet (2 commits)")[![tobyS](https://avatars.githubusercontent.com/u/187140?v=4)](https://github.com/tobyS "tobyS (2 commits)")[![vukanac](https://avatars.githubusercontent.com/u/2384207?v=4)](https://github.com/vukanac "vukanac (2 commits)") ### Embed Badge ![Health badge](/badges/theseer-phpdox/health.svg) ``` [![Health](https://phpackages.com/badges/theseer-phpdox/health.svg)](https://phpackages.com/packages/theseer-phpdox) ``` ### Alternatives [symfony/maker-bundle Symfony Maker helps you create empty commands, controllers, form classes, tests and more so you can forget about writing boilerplate code. 3.4k111.1M568](/packages/symfony-maker-bundle)[roave/backward-compatibility-check Tool to compare two revisions of a public API to check for BC breaks 5953.3M56](/packages/roave-backward-compatibility-check)[coenjacobs/mozart Composes all dependencies as a package inside a WordPress plugin 4723.6M20](/packages/coenjacobs-mozart)[psalm/plugin-laravel Psalm plugin for Laravel 3274.9M308](/packages/psalm-plugin-laravel)[recca0120/laravel-erd Laravel ERD automatically generates Entity-Relationship Diagrams from your Laravel models and displays them using Vuerd. 36072.0k](/packages/recca0120-laravel-erd)[ondrejmirtes/better-reflection Better Reflection - an improved code reflection API 136.2M4](/packages/ondrejmirtes-better-reflection) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)