\phpDocumentor\DescriptorTocDescriptor

Summary

Methods
Properties
Constants
__construct()
getName()
getDescription()
addEntry()
getRoots()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$name
$entries
N/A

Properties

$name

$name : string

Type

string

$entries

$entries : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TableOfContents\Entry>

Type

Entry>

Methods

__construct()

__construct(string  $name) : mixed

Parameters

string $name

Returns

mixed —

getName()

getName() : string

Returns the local name for this element.

Returns

string —

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 —

addEntry()

addEntry(\phpDocumentor\Descriptor\TableOfContents\Entry  $entry) : void

Parameters

\phpDocumentor\Descriptor\TableOfContents\Entry $entry

getRoots()

getRoots() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TableOfContents\Entry>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TableOfContents\Entry> —