Documentation

Configuration
in package

Table of Contents

$fileExtension  : string
$formats  : array<string|int, Format>
$indexName  : string
$initialHeaderLevel  : int
$outputFolder  : string
$sourceFileExtension  : string
__construct()  : mixed
addFormat()  : void
getFileExtension()  : string
getFormat()  : Format
getInitialHeaderLevel()  : int
getNameOfIndexFile()  : string
getOutputFolder()  : string
getSourceFileExtension()  : string
setFileExtension()  : void
setInitialHeaderLevel()  : void
setOutputFolder()  : void

Properties

Methods

__construct()

public __construct(string $sourceFileExtension, iteratable<int, Format> $outputFormats) : mixed
Parameters
$sourceFileExtension : string
$outputFormats : iteratable<int, Format>
Return values
mixed —

getFileExtension()

public getFileExtension() : string
Return values
string —

getInitialHeaderLevel()

public getInitialHeaderLevel() : int
Return values
int —

getNameOfIndexFile()

public getNameOfIndexFile() : string
Return values
string —

getOutputFolder()

public getOutputFolder() : string
Return values
string —

getSourceFileExtension()

public getSourceFileExtension() : string
Return values
string —

setFileExtension()

public setFileExtension(string $fileExtension) : void
Parameters
$fileExtension : string
Return values
void —

setInitialHeaderLevel()

public setInitialHeaderLevel(int $initialHeaderLevel) : void
Parameters
$initialHeaderLevel : int
Return values
void —

setOutputFolder()

public setOutputFolder(string $outputFolder) : void
Parameters
$outputFolder : string
Return values
void —

Search results