Properties

$initialHeaderLevel

$initialHeaderLevel : int

Type

int

$fileExtension

$fileExtension : string

Type

string

$indexName

$indexName : string

Type

string

$sourceFileExtension

$sourceFileExtension : string

Type

string

$formats

$formats : \phpDocumentor\Guides\Formats\Format[]

Type

Format[]

$outputFolder

$outputFolder : string

Type

string

Methods

__construct()

__construct(string  $sourceFileExtension, iterable<int,\phpDocumentor\Guides\Formats\Format>  $outputFormats) : mixed

Parameters

string $sourceFileExtension
iterable $outputFormats

Returns

mixed —

getInitialHeaderLevel()

getInitialHeaderLevel() : int

Returns

int —

setInitialHeaderLevel()

setInitialHeaderLevel(int  $initialHeaderLevel) : void

Parameters

int $initialHeaderLevel

getFileExtension()

getFileExtension() : string

Returns

string —

setFileExtension()

setFileExtension(string  $fileExtension) : void

Parameters

string $fileExtension

getFormat()

getFormat() : \phpDocumentor\Guides\Formats\Format

Returns

\phpDocumentor\Guides\Formats\Format —

addFormat()

addFormat(\phpDocumentor\Guides\Formats\Format  ...$format) : void

Parameters

\phpDocumentor\Guides\Formats\Format $format variadic

getNameOfIndexFile()

getNameOfIndexFile() : string

Returns

string —

getSourceFileExtension()

getSourceFileExtension() : string

Returns

string —

getOutputFolder()

getOutputFolder() : string

Returns

string —

setOutputFolder()

setOutputFolder(string  $outputFolder) : void

Parameters

string $outputFolder