\phpDocumentor\Descriptor\TagThrowsDescriptor

Descriptor representing the throws tag on a class or trait.

Summary

Methods
Properties
Constants
setTypes()
setType()
getTypes()
getType()
__construct()
getName()
setDescription()
getDescription()
__toString()
setErrors()
getErrors()
No public properties found
No constants found
setName()
$types
$name
$description
$errors
N/A
No private methods found
No private properties found
N/A

Properties

$types

$types : \phpDocumentor\Reflection\Type|null

Type

Type|null

$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.

Methods

setTypes()

setTypes(?\phpDocumentor\Reflection\Type  $types = null) : void

Sets a list of types associated with this tag.

Parameters

?\phpDocumentor\Reflection\Type $types

setType()

setType(?\phpDocumentor\Reflection\Type  $types = null) : void

Sets a list of types associated with this tag.

Parameters

?\phpDocumentor\Reflection\Type $types

getTypes()

getTypes() : \phpDocumentor\Descriptor\Tag\BaseTypes\list<\phpDocumentor\Reflection\Type>

Returns the list of types associated with this tag.

Returns

\phpDocumentor\Descriptor\Tag\BaseTypes\list<\phpDocumentor\Reflection\Type> —

getType()

getType() : ?\phpDocumentor\Reflection\Type

Returns

?\phpDocumentor\Reflection\Type —

__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> —

setName()

setName(string  $name) : void

Sets the name for this tag.

Parameters

string $name