2021-02-05 13:50:43 +00:00
|
|
|
# doctum
|
|
|
|
|
|
2024-04-25 23:58:21 +01:00
|
|
|
> Generate documentation for a PHP API.
|
2021-02-05 13:50:43 +00:00
|
|
|
> More information: <https://github.com/code-lts/doctum>.
|
|
|
|
|
|
|
|
|
|
- Parse a project:
|
|
|
|
|
|
|
|
|
|
`doctum parse`
|
|
|
|
|
|
|
|
|
|
- Render a project:
|
|
|
|
|
|
|
|
|
|
`doctum render`
|
|
|
|
|
|
|
|
|
|
- Parse then render a project:
|
|
|
|
|
|
|
|
|
|
`doctum update`
|
|
|
|
|
|
|
|
|
|
- Parse and render only a specific version of a project:
|
|
|
|
|
|
|
|
|
|
`doctum update --only-version={{version}}`
|
|
|
|
|
|
|
|
|
|
- Parse and render a project using a specific configuration:
|
|
|
|
|
|
|
|
|
|
`doctum update {{path/to/config.php}}`
|
