Properties

$name

$name : string

Type

string

$source

$source : \phpDocumentor\Configuration\Source

Type

Source

$outputLocation

$outputLocation : string

Type

string

$tocs

$tocs : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TocDescriptor>

Type

TocDescriptor>

$inputFormat

$inputFormat : string

Type

string

$outputFormat

$outputFormat : string

Type

string

$documents

$documents : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\DocumentDescriptor>

Type

DocumentDescriptor>

$initialHeaderLevel

$initialHeaderLevel : int

Type

int

Methods

__construct()

__construct(string  $name, \phpDocumentor\Configuration\Source  $source, string  $outputLocation, string  $inputFormat, string  $outputFormat = 'html', int  $initialHeaderLevel = 1) : mixed

Parameters

string $name
\phpDocumentor\Configuration\Source $source
string $outputLocation
string $inputFormat
string $outputFormat
int $initialHeaderLevel

Returns

mixed —

getName()

getName() : string

Returns

string —

addTableOfContents()

addTableOfContents(\phpDocumentor\Descriptor\TocDescriptor  $descriptor) : void

Parameters

\phpDocumentor\Descriptor\TocDescriptor $descriptor

getTableOfContents()

getTableOfContents() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TocDescriptor>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TocDescriptor> —

getSource()

getSource() : \phpDocumentor\Configuration\Source

Returns the source location for this set of documentation.

Returns

\phpDocumentor\Configuration\Source —

getOutputLocation()

getOutputLocation() : string

Returns

string —

addDocument()

addDocument(string  $file, \phpDocumentor\Descriptor\DocumentDescriptor  $documentDescriptor) : void

Parameters

string $file
\phpDocumentor\Descriptor\DocumentDescriptor $documentDescriptor

getInputFormat()

getInputFormat() : string

Returns

string —

getOutputFormat()

getOutputFormat() : string

Returns

string —

getInitialHeaderLevel()

getInitialHeaderLevel() : int

Returns

int —

getDocuments()

getDocuments() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\DocumentDescriptor>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\DocumentDescriptor> —