Properties

$name

$name : string

Type

string

$description

$description : ?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Type

?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

$package

$package : \phpDocumentor\Descriptor\Interfaces\PackageInterface|string

Type

\phpDocumentor\Descriptor\Interfaces\PackageInterface|string — The package with which this element is associated

$namespace

$namespace : \phpDocumentor\Descriptor\Interfaces\NamespaceInterface|string

Type

\phpDocumentor\Descriptor\Interfaces\NamespaceInterface|string — The namespace for this element

$files

$files : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\FileInterface>

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\FileInterface> —

$indexes

$indexes : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ElementInterface>>

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ElementInterface>> —

$settings

$settings : \phpDocumentor\Descriptor\ProjectDescriptor\Settings

Type

\phpDocumentor\Descriptor\ProjectDescriptor\Settings

$partials

$partials : \phpDocumentor\Descriptor\Collection<string>

Type

\phpDocumentor\Descriptor\Collection

$versions

$versions : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor>

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor> —

Methods

getName()

getName() : string

Returns the name for this element.

Returns

string —

setDescription()

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

Sets a description or none to inherit from a parent.

Parameters

?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor $description

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

\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor —

getPackage()

getPackage() : ?\phpDocumentor\Descriptor\Interfaces\PackageInterface

Returns the package name for this element.

Returns

?\phpDocumentor\Descriptor\Interfaces\PackageInterface —

getNamespace()

getNamespace() : \phpDocumentor\Descriptor\Interfaces\NamespaceInterface|string

Returns the namespace for this element (defaults to global "\")

Returns

\phpDocumentor\Descriptor\Interfaces\NamespaceInterface|string —

__construct()

__construct(string  $name) : mixed

Initializes this descriptor.

Parameters

string $name

Returns

mixed —

setFiles()

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

Sets all files on this project.

Parameters

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\FileInterface> $files

getFiles()

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

Returns all files with their sub-elements.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\FileInterface> —

setIndexes()

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

Sets all indexes for this project.

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

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ElementInterface>> $indexes

getIndexes()

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

Returns all indexes in this project.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ElementInterface>> —

setSettings()

setSettings(\phpDocumentor\Descriptor\ProjectDescriptor\Settings  $settings) : void

Sets the settings used to build the documentation for this project.

Parameters

\phpDocumentor\Descriptor\ProjectDescriptor\Settings $settings

getSettings()

getSettings() : \phpDocumentor\Descriptor\ProjectDescriptor\Settings

Returns the settings used to build the documentation for this project.

Returns

\phpDocumentor\Descriptor\ProjectDescriptor\Settings —

setPartials()

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.

Parameters

\phpDocumentor\Descriptor\Collection $partials

getPartials()

getPartials() : \phpDocumentor\Descriptor\Collection<string>

Returns a list of all partials.

Returns

\phpDocumentor\Descriptor\Collection

findElement()

findElement(\phpDocumentor\Reflection\Fqsen  $fqsen) : ?\phpDocumentor\Descriptor\Interfaces\ElementInterface

Parameters

\phpDocumentor\Reflection\Fqsen $fqsen

Returns

?\phpDocumentor\Descriptor\Interfaces\ElementInterface —

getVersions()

getVersions() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor> —