\phpDocumentor\Descriptor\TagThrowsDescriptor

Descriptor representing the throws tag on a class or trait.

Summary

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

Properties

$type

$type : \phpDocumentor\Reflection\Type|null

Type

\phpDocumentor\Reflection\Type|null — normalized type of this argument

$name

$name : string

Type

string

$description

$description : ?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Type

?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

$errors

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

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> — A collection of errors found during filtering.

Methods

setType()

setType(?\phpDocumentor\Reflection\Type  $type) : void

Parameters

?\phpDocumentor\Reflection\Type $type

getType()

getType() : ?\phpDocumentor\Reflection\Type

Returns

?\phpDocumentor\Reflection\Type —

getTypes()

getTypes() : list<\phpDocumentor\Reflection\Type>

Returns

list<\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 —

__toString()

__toString() : string

Returns

string —

getName()

getName() : string

Returns the name for this element.

Returns

string —

setDescription()

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

Sets a description or none to inherit from a parent.

Parameters

?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor $description

getDescription()

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

Returns the description for this element.

This method will automatically attempt to inherit the parent's description if this one has none.

Returns

\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor —

getErrors()

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

Returns all errors associated with this tag.

Returns

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