DocModule

Less than 1 minute

Class DocModule

Console module for working with API documentation. Provides commands to generate and index API documentation.

Properties

private Documentor $doc

Configures the module by adding documentation-related commands and options.

protected configure(): void

Prepares the documentor with output and scan paths, and sets the documentation title.

protected prepare(Input $input, Output $output): int

Parameter	Type	Description
`$input`	`Input`	The input interface for command arguments.
`$output`	`Output`	The output interface for writing messages.

Generates the API documentation.

protected generate(Input $input, Output $output): int

Parameter	Type	Description
`$input`	`Input`	The input interface for command arguments.
`$output`	`Output`	The output interface for writing messages.

Generates the API documentation index.

protected index(Input $input, Output $output): int

Parameter	Type	Description
`$input`	`Input`	The input interface for command arguments.
`$output`	`Output`	The output interface for writing messages.

Generated by Hazaar API Doc Generator on Sun, 01 Mar 2026 09:22:27 +0000