2025-03-14 21:59:59 -06:00
|
|
|
# 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:
|
|
|
|
|
|
2025-05-08 12:26:01 -06:00
|
|
|
`phpdox {{[-f|--file]}} {{path/to/phpdox.xml}}`
|
2025-03-14 21:59:59 -06:00
|
|
|
|
|
|
|
|
- Only run the metadata collection process:
|
|
|
|
|
|
2025-05-08 12:26:01 -06:00
|
|
|
`phpdox {{[-c|--collector]}}`
|
2025-03-14 21:59:59 -06:00
|
|
|
|
|
|
|
|
- Only run the documentation generator process:
|
|
|
|
|
|
2025-05-08 12:26:01 -06:00
|
|
|
`phpdox {{[-g|--generator]}}`
|
