\phpDocumentor\Descriptor\TagPropertyDescriptor

Descriptor representing the property tag on a class or trait.

Summary

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

Properties

$variableName

$variableName : string

Type

string — variableName

$name

$name : string

Type

string — Name of the tag.

$description

$description : string

Type

string — A description line for this tag

Methods

getVariableName()

getVariableName() : string

Retrieves the variable name stored on this descriptor.

Returns

string

setVariableName()

setVariableName(string  $variableName) : void

Sets the variable name on this descriptor.

Parameters

string $variableName

__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