DocModule

Less than 1 minute

Class DocModule.

class DocModule extends \Hazaar\Console\Modules\Module

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 Tue, 21 Apr 2026 04:00:25 +0000