$name
$name : string
Represents the entire project with its files, namespaces and indexes.
getIndexes() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ElementInterface>>
Returns all indexes in this project.
None found |
setSettings(\phpDocumentor\Descriptor\ProjectDescriptor\Settings $settings) : void
Sets the settings used to build the documentation for this project.
\phpDocumentor\Descriptor\ProjectDescriptor\Settings | $settings |
None found |
getSettings() : \phpDocumentor\Descriptor\ProjectDescriptor\Settings
Returns the settings used to build the documentation for this project.
None found |
setPartials(\phpDocumentor\Descriptor\Collection<string> $partials) : void
Sets all partials that can be used in a template.
Partials are blocks of text that can be inserted anywhere in a template using a special indicator. An example is the introduction partial that can add a custom piece of text to the homepage.
\phpDocumentor\Descriptor\Collection |
$partials |
None found |
getPartials() : \phpDocumentor\Descriptor\Collection<string>
Returns a list of all partials.
None found |
getVersions() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor>
None found |
getApiDocumentationSet() : \phpDocumentor\Descriptor\ApiSetDescriptor
Retrieves the first API Documentation set from the first version.
None found |