DocModule
Less than 1 minute
DocModule
Class DocModule.
class DocModule extends \Hazaar\Console\ModuleExtends: Hazaar\Console\Module
Console module for working with API documentation. Provides commands to generate and index API documentation.
Properties
doc
private Documentor $docType: Hazaar\Console\API\Documentor
Methods
configure
Configures the module by adding documentation-related commands and options.
protected configure(): voidReturns: void
prepare
Prepares the documentor with output and scan paths, and sets the documentation title.
protected prepare(Input $input, Output $output): intReturns: int
Parameters
| Parameter | Type | Description |
|---|---|---|
$input | Hazaar\Console\Input | the input interface for command arguments |
$output | Hazaar\Console\Output | the output interface for writing messages |
generate
Generates the API documentation.
protected generate(Input $input, Output $output): intReturns: int
Parameters
| Parameter | Type | Description |
|---|---|---|
$input | Hazaar\Console\Input | the input interface for command arguments |
$output | Hazaar\Console\Output | the output interface for writing messages |
index
Generates the API documentation index.
protected index(Input $input, Output $output): intReturns: int
Parameters
| Parameter | Type | Description |
|---|---|---|
$input | Hazaar\Console\Input | the input interface for command arguments |
$output | Hazaar\Console\Output | the output interface for writing messages |
Generated by Hazaar API Doc Generator on Fri, 04 Sep 2026 23:32:18 +0000