\phpDocumentor\DescriptorGuideSetDescriptor

Summary

Methods
Properties
Constants
__construct()
getName()
addTableOfContents()
getTableOfContents()
getSource()
getOutput()
addDocument()
getInputFormat()
getDocuments()
No public properties found
No constants found
No protected methods found
$name
$source
$output
N/A
No private methods found
$tocs
$inputFormat
$documents
N/A

Properties

$name

$name : string

Type

string

$source

$source : \phpDocumentor\Configuration\Source

Type

Source

$output

$output : string

Type

string

$tocs

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

Type

TocDescriptor>

$inputFormat

$inputFormat : string

Type

string

$documents

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

Type

DocumentDescriptor>

Methods

__construct()

__construct(string  $name, \phpDocumentor\Configuration\Source  $source, string  $output, string  $inputFormat) : mixed

Parameters

string $name
\phpDocumentor\Configuration\Source $source
string $output
string $inputFormat

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 —

getOutput()

getOutput() : string

Returns

string —

addDocument()

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

Parameters

string $file
\phpDocumentor\Descriptor\DocumentDescriptor $documentDescriptor

getInputFormat()

getInputFormat() : string

Returns

string —

getDocuments()

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

Returns

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