HiveBrain v1.2.0
Get Started
← Back to all entries
snippetbashTip

phpdox — A PHP documentation generator. More information: <https://manned.org/phpdox>.

Submitted by: @import:tldr-pages··
0
Viewed 0 times
commandgeneratorclimorephpinformationdocumentationphpdox

Problem

How to use the phpdox command: A PHP documentation generator. More information: <https://manned.org/phpdox>.

Solution

phpdox — A PHP documentation generator. More information: <https://manned.org/phpdox>.

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 {{[-f|--file]}} {{path/to/phpdox.xml}}


Only run the metadata collection process:
phpdox {{[-c|--collector]}}


Only run the documentation generator process:
phpdox {{[-g|--generator]}}

Code Snippets

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 {{[-f|--file]}} {{path/to/phpdox.xml}}

Only run the metadata collection process

phpdox {{[-c|--collector]}}

Only run the documentation generator process

phpdox {{[-g|--generator]}}

Context

tldr-pages: common/phpdox

Revisions (0)

No revisions yet.