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

doctum — Generate documentation for a PHP API. More information: <https://github.com/code-lts/doctum>.

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

Problem

How to use the doctum command: Generate documentation for a PHP API. More information: <https://github.com/code-lts/doctum>.

Solution

doctum — Generate documentation for a PHP API. 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}}

Code Snippets

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}}

Context

tldr-pages: common/doctum

Revisions (0)

No revisions yet.