Guides

ProjectSettings
in package

FinalYes

Table of Contents

Properties

$automaticMenu  : bool
$copyright  : string
$defaultCodeLanguage  : string
$excludes  : Exclude
$failOnError  : LogLevel::*|null
$ignoredDomains  : string[]
$indexName  : string
$input  : string
$inputFile  : string
$inputFormat  : string
$inventories  : array<string, string>
$linksRelative  : bool
$logPath  : string
$maxMenuDepth  : int
$output  : string
$outputFormats  : string[]
$release  : string
$showProgressBar  : bool
$theme  : string
$title  : string
$version  : string
$violationFile  : string|null
$violationFormat  : string|null

Methods

__construct()  : mixed
getCopyright()  : string
getDefaultCodeLanguage()  : string
getExcludes()  : Exclude
getFailOnError()  : LogLevel::*
getIgnoredDomains()  : string[]
getIndexName()  : string
getInput()  : string
getInputFile()  : string
getInputFormat()  : string
getInventories()  : array<string, string>
getLogPath()  : string
getMaxMenuDepth()  : int
getOutput()  : string
getOutputFormats()  : string[]
getRelease()  : string
getTheme()  : string
getTitle()  : string
getVersion()  : string
getViolationFile()  : string|null
File to write the report of the violation format to, for formats that write a file, like "gitlab". Each format has its own default.
getViolationFormat()  : string|null
Format to report the problems found in the documentation source in, in addition to the log, like "github" for annotations in GitHub Actions or "gitlab" for the code quality report of GitLab CI
isAutomaticMenu()  : bool
isFailOnError()  : bool
isLinksRelative()  : bool
isShowProgressBar()  : bool
setAutomaticMenu()  : ProjectSettings
setCopyright()  : void
setDefaultCodeLanguage()  : void
setExcludes()  : void
setFailOnError()  : void
setIgnoredDomains()  : void
setIndexName()  : ProjectSettings
setInput()  : void
setInputFile()  : void
setInputFormat()  : void
setInventories()  : void
setLinksRelative()  : void
setLogPath()  : void
setMaxMenuDepth()  : ProjectSettings
setOutput()  : void
setOutputFormats()  : void
setRelease()  : void
setShowProgressBar()  : void
setTheme()  : void
setTitle()  : void
setVersion()  : void
setViolationFile()  : void
setViolationFormat()  : void

Properties

Methods

getDefaultCodeLanguage()

public getDefaultCodeLanguage() : string
Return values
string

getFailOnError()

public getFailOnError() : LogLevel::*
Return values
LogLevel::*

getIgnoredDomains()

public getIgnoredDomains() : string[]
Return values
string[]

getInputFormat()

public getInputFormat() : string
Return values
string

getInventories()

public getInventories() : array<string, string>
Return values
array<string, string>

getOutputFormats()

public getOutputFormats() : string[]
Return values
string[]

getViolationFile()

File to write the report of the violation format to, for formats that write a file, like "gitlab". Each format has its own default.

public getViolationFile() : string|null
Return values
string|null

getViolationFormat()

Format to report the problems found in the documentation source in, in addition to the log, like "github" for annotations in GitHub Actions or "gitlab" for the code quality report of GitLab CI

public getViolationFormat() : string|null
Return values
string|null

isAutomaticMenu()

public isAutomaticMenu() : bool
Return values
bool

isLinksRelative()

public isLinksRelative() : bool
Return values
bool

isShowProgressBar()

public isShowProgressBar() : bool
Return values
bool

setCopyright()

public setCopyright(string $copyright) : void
Parameters
$copyright : string

setDefaultCodeLanguage()

public setDefaultCodeLanguage(string $defaultCodeLanguage) : void
Parameters
$defaultCodeLanguage : string

setFailOnError()

public setFailOnError(LogLevel::* $logLevel) : void
Parameters
$logLevel : LogLevel::*

setIgnoredDomains()

public setIgnoredDomains(string[] $ignoredDomains) : void
Parameters
$ignoredDomains : string[]

setInput()

public setInput(string $input) : void
Parameters
$input : string

setInputFile()

public setInputFile(string $inputFile) : void
Parameters
$inputFile : string

setInputFormat()

public setInputFormat(string $inputFormat) : void
Parameters
$inputFormat : string

setInventories()

public setInventories(array<string, string> $inventories) : void
Parameters
$inventories : array<string, string>

setLinksRelative()

public setLinksRelative(bool $linksRelative) : void
Parameters
$linksRelative : bool

setLogPath()

public setLogPath(string $logPath) : void
Parameters
$logPath : string

setOutput()

public setOutput(string $output) : void
Parameters
$output : string

setOutputFormats()

public setOutputFormats(string[] $outputFormats) : void
Parameters
$outputFormats : string[]

setRelease()

public setRelease(string $release) : void
Parameters
$release : string

setShowProgressBar()

public setShowProgressBar(bool $showProgressBar) : void
Parameters
$showProgressBar : bool

setTheme()

public setTheme(string $theme) : void
Parameters
$theme : string

setTitle()

public setTitle(string $title) : void
Parameters
$title : string

setVersion()

public setVersion(string $version) : void
Parameters
$version : string

setViolationFile()

public setViolationFile(string|null $violationFile) : void
Parameters
$violationFile : string|null

setViolationFormat()

public setViolationFormat(string|null $violationFormat) : void
Parameters
$violationFormat : string|null
On this page

Search results