phpdox
A PHP documentation generator.
TLDR
Display an annotated skeleton configuration XML file
$ phpdox --skel
Generate documentation for the current working directory
$ phpdox
Generate documentation using a specific configuration file
$ phpdox --file [path/to/phpdox.xml]
Only run the metadata collection process
$ phpdox --collector
Only run the documentation generator process
$ phpdox --generator
SYNOPSIS
phpdox [switches]
DESCRIPTION
phpDox 0.12.0-dev - Copyright (C) 2010 - 2021 by Arne Blankerts and Contributors
- -f, --file
-
Configuration file to use (defaults to ./phpdox.xml[.dist])
- -h, --help
-
Prints this usage information
- -v, --version
-
Prints the version and exits
- -c, --collector
-
Run only collector process
- -g, --generator
-
Run only generator process
- --backends
-
Show a list of available backends and exit
- --engines
-
Show a list of available output engines and exit
- --enrichers
-
Show a list of available output enrichers and exit
- --skel
-
Show an annotated skeleton config xml file and exit
- --strip
-
Strip comments from skeleton config xml when showing
