$name
$name : string
__construct(string $name, \phpDocumentor\Configuration\Source $source, string $outputLocation, \phpDocumentor\Configuration\ApiSpecification $apiSpecification) : mixed
string | $name | |
\phpDocumentor\Configuration\Source | $source | |
string | $outputLocation | |
\phpDocumentor\Configuration\ApiSpecification | $apiSpecification |
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.
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ElementInterface>> | $indexes |
getIndexes() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ElementInterface>>
Returns all indexes in this documentation set.
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.
string | $name |
findElement(\phpDocumentor\Reflection\Fqsen $fqsen) : ?\phpDocumentor\Descriptor\Interfaces\ElementInterface
Finds a structural element with the given FQSEN in this Documentation Set, or returns null when it could not be found.
\phpDocumentor\Reflection\Fqsen | $fqsen |