\phpDocumentor\Descriptor\TagSeeDescriptor

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

Summary

Methods
Properties
Constants
__construct()
getName()
setDescription()
getDescription()
setErrors()
getErrors()
setReference()
getReference()
No public properties found
No constants found
setName()
$name
$description
$errors
$reference
N/A
No private methods found
No private properties found
N/A

Properties

$name

$name : string

Type

string — Name of the tag.

$description

$description : string

Type

string — A description line for this tag

Methods

__construct()

__construct(string  $name) 

Initializes the tag by setting the name and errors,

Parameters

string $name

getName()

getName() : string

Returns the name for this tag.

Returns

string

setDescription()

setDescription(string  $description) : void

Sets a description for this tab instance.

Parameters

string $description

getDescription()

getDescription() : string

Returns the description for this tag,

Returns

string

setErrors()

setErrors(\phpDocumentor\Descriptor\Collection  $errors) : void

Sets a list of errors found on the usage of this tag.

Parameters

\phpDocumentor\Descriptor\Collection $errors

setName()

setName(string  $name) : void

Sets the name for this tag.

Parameters

string $name