phpDocumentor

TocDescriptor
in package
implements Descriptor uses HasName, HasDescription

FinalYes

Table of Contents

Interfaces

Descriptor
Base class for descriptors containing the most used options.

Properties

$description  : DescriptionDescriptor|null
$name  : string
$count  : int
$entries  : Collection<string|int, Entry>

Methods

__construct()  : mixed
addEntry()  : void
getDescription()  : DescriptionDescriptor
Returns the description for this element.
getName()  : string
Returns the name for this element.
getRoots()  : Collection<string|int, Entry>
setDescription()  : void
Sets a description or none to inherit from a parent.

Properties

Methods

__construct()

public __construct(string $name) : mixed
Parameters
$name : string

getName()

Returns the name for this element.

public getName() : string
Return values
string

        
On this page

Search results