2021-02-05 14:08:48 +00: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-04-27 10:59:15 +03:00
|
|
|
`phpdox {{[-f|--file]}} {{path/to/phpdox.xml}}`
|
2021-02-05 14:08:48 +00:00
|
|
|
|
|
|
|
- Only run the metadata collection process:
|
|
|
|
|
2025-04-27 10:59:15 +03:00
|
|
|
`phpdox {{[-c|--collector]}}`
|
2021-02-05 14:08:48 +00:00
|
|
|
|
|
|
|
- Only run the documentation generator process:
|
|
|
|
|
2025-04-27 10:59:15 +03:00
|
|
|
`phpdox {{[-g|--generator]}}`
|