Documentor

Constants

DOC_OUTPUT_HTML

public const DOC_OUTPUT_HTML = 1

DOC_OUTPUT_MARKDOWN

public const DOC_OUTPUT_MARKDOWN = 2

DOC_OUTPUT_INDEX

public const DOC_OUTPUT_INDEX = 3

Properties

outputFormat

private int $outputFormat

title

public string $title

public  $

public  $

outputPath

private string $outputPath

scanPath

private string $scanPath

Methods

__construct

public __construct(int $outputFormat, ?string $title): void

Parameters

Parameter	Type	Description
$outputFormat	int
$title	string

setCallback

public setCallback(\Closure $callback): void

Parameters

Parameter	Type	Description
$callback	\Closure

setScanPath

public setScanPath(string $scanPath): bool

Parameters

Parameter	Type	Description
$scanPath	string

setOutputPath

public setOutputPath(string $outputPath): void

Parameters

Parameter	Type	Description
$outputPath	string

generate

public generate(): bool

generateIndex

public generateIndex(string $style = 'vuepress'): bool

Parameters

Parameter	Type	Description
$style	string

scan

private scan(): bool

render

private render(\stdClass $index, string $outputPath): bool

Parameters

Parameter	Type	Description
$index	\stdClass
$outputPath	string

renderNamespace

private renderNamespace(\stdClass $namespace, array $subdirs, array $template): void

Parameters

Parameter	Type	Description
$namespace	\stdClass
$subdirs	array
$template	array

loadTemplates

private loadTemplates(string $path, int $outputFormat = 2): void

Parameters

Parameter	Type	Description
$path	string
$outputFormat	int

updateIndex

private updateIndex(\stdClass $index, ParserFile $parsedFile): void

Parameters

Parameter	Type	Description
$index	\stdClass
$parsedFile	ParserFile

pushIndexItem

private pushIndexItem(array $array, array $items): void

Parameters

Parameter	Type	Description
$array	array
$items	array

getFiles

private getFiles(string $path): void

Parameters

Parameter	Type	Description
$path	string

postProcessRemoveEmptyLines

private postProcessRemoveEmptyLines(string $content): string

Parameters

Parameter	Type	Description
$content	string

postProcessReplaceClassLinks

private postProcessReplaceClassLinks(string $content): string

Parameters

Parameter	Type	Description
$content	string

log

private log(string $message): void

Parameters

Parameter	Type	Description
$message	string

createNamespaceHierarchy

private createNamespaceHierarchy(\stdClass $item): void

Parameters

Parameter	Type	Description
$item	\stdClass

---

Generated by Hazaar API Doc Generator