\phpDocumentor\DescriptorDocumentationSetDescriptor

getName()

getName() : string

Returns the name for this element.

Returns

setDescription()

setDescription(?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor  $description) : void

Sets a description or none to inherit from a parent.

Parameters

getDescription()

getDescription() : \phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Returns the description for this element.

This method will automatically attempt to inherit the parent's description if this one has none.

Returns

__construct()

__construct() : mixed

Returns

addTableOfContents()

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

Parameters

getTableOfContents()

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

Returns

getSource()

getSource() : \phpDocumentor\Configuration\Source

Returns the source location for this set of documentation.

Returns

getOutputLocation()

getOutputLocation() : string

Returns

setFiles()

setFiles(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\FileInterface>  $files) : void

Sets the list of files that is in this documentation set.

Parameters

getFiles()

getFiles() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\FileInterface>

Returns the list of files that is in this documentation set.

Returns

setIndexes()

setIndexes(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ElementInterface>>  $indexes) : void

Sets all indexes for this documentation set.

An index is a compilation of references to elements, usually constructed in a compiler step, that aids template generation by providing a conveniently assembled list. An example of such an index is the 'marker' index where a list of TODOs and FIXMEs are located in a central location for reporting.

Parameters

getIndexes()

getIndexes() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ElementInterface>>

Returns all indexes in this documentation set.

Returns

getIndex()

getIndex(string  $name) : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ElementInterface>

Returns an index with the given name.

If the index does not exist yet, it will dynamically be added to the list of indexes.

Parameters

Returns