25 lines
471 B
Markdown
25 lines
471 B
Markdown
|
# phpdox
|
||
|
|
|
||
|
|
> A PHP documentation generator.
|
||
|
|
> More information: <https://phpdox.net>.
|
||
|
|
|
||
|
|
- 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`
|