phpDocumentor

SeeDescriptor extends TagDescriptor
in package
implements Stringable

Base class for any tag descriptor and used when a tag has no specific descriptor.

Table of Contents

Interfaces

Stringable

Properties

$description  : DescriptionDescriptor|null
$errors  : Collection<string|int, Error>
$name  : string
$reference  : Reference

Methods

__construct()  : mixed
Initializes the tag by setting the name and errors,
__toString()  : string
getDescription()  : DescriptionDescriptor
Returns the description for this element.
getErrors()  : Collection<string|int, Error>
Returns all errors associated with this tag.
getName()  : string
Returns the name for this element.
getReference()  : Reference
setDescription()  : void
Sets a description or none to inherit from a parent.

Properties

Methods

__construct()

Initializes the tag by setting the name and errors,

public __construct(string $name, Reference $reference[, DescriptionDescriptor|null $description = null ]) : mixed
Parameters
$name : string
$reference : Reference
$description : DescriptionDescriptor|null = null

__toString()

public __toString() : string
Return values
string

getName()

Returns the name for this element.

public getName() : string
Return values
string

getReference()

public getReference() : Reference
Return values
Reference

        
On this page

Search results