\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()
__toString()
setErrors()
getErrors()
setReference()
getReference()
No public properties found
No constants found
setName()
$name
$description
$errors
N/A
No private methods found
$reference
N/A

Properties

$name

$name : string

Type

string — Name of the tag.

$description

$description : \phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Type

DescriptionDescriptor — A description line for this tag

$errors

$errors : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>

Type

Error> — A collection of errors found during filtering.

$reference

$reference : \phpDocumentor\Reflection\DocBlock\Tags\Reference\Reference

Type

\phpDocumentor\Reflection\DocBlock\Tags\Reference\Reference —

Methods

__construct()

__construct(string  $name, ?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor  $description = null) : mixed

Initializes the tag by setting the name and errors,

Parameters

string $name
?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor $description

Returns

mixed —

getName()

getName() : string

Returns the name for this tag.

Returns

string —

setDescription()

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

Sets a description for this tab instance.

Parameters

?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor $description

getDescription()

getDescription() : \phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Returns the description for this tag,

Returns

\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor —

__toString()

__toString() : string

Returns

string —

setErrors()

setErrors(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>  $errors) : void

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

Parameters

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> $errors

getErrors()

getErrors() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>

Returns all errors associated with this tag.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> —

setReference()

setReference(\phpDocumentor\Reflection\DocBlock\Tags\Reference\Reference  $reference) : void

Parameters

\phpDocumentor\Reflection\DocBlock\Tags\Reference\Reference $reference

getReference()

getReference() : \phpDocumentor\Reflection\DocBlock\Tags\Reference\Reference

Returns

\phpDocumentor\Reflection\DocBlock\Tags\Reference\Reference —

setName()

setName(string  $name) : void

Sets the name for this tag.

Parameters

string $name