ParamDescriptor

Extends \phpDocumentor\Descriptor\Tag\BaseTypes\TypedVariableAbstract

Descriptor representing the param tag with a function or method.

package

Default

Methods

Initializes the tag by setting the name and errors,

__construct(string $name) 
inherited

Arguments

$name

string

Returns the description for this tag,

getDescription() : string
inherited

Response

string

Returns all errors associated with this tag.

getErrors() : \phpDocumentor\Descriptor\Collection
inherited

Returns the name for this tag.

getName() : string
inherited

Response

string

Returns the list of types associated with this tag.

getTypes() : \phpDocumentor\Descriptor\Collection
inherited

Retrieves the variable name stored on this descriptor.

getVariableName() : string
inherited

Response

string

Sets a description for this tab instance.

setDescription(string $description) : void
inherited

Arguments

$description

string

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

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

Sets the name for this tag.

setName(string $name) : void
inherited

Arguments

$name

string

Sets a list of types associated with this tag.

setTypes(\phpDocumentor\Descriptor\Collection $types) : void
inherited

Sets the variable name on this descriptor.

setVariableName(string $variableName) : void
inherited

Arguments

$variableName

string

Properties

variableName

variableName : string
inherited
var

variableName

Type(s)

string

types

types : \phpDocumentor\Descriptor\Collection
inherited

Name of the tag.

name : string
inherited
var

Name of the tag.

Type(s)

string

A description line for this tag

description : string
inherited
var

A description line for this tag

Type(s)

string

A collection of errors found during filtering.

errors : \phpDocumentor\Descriptor\Collection
inherited
var

A collection of errors found during filtering.

Type(s)

\phpDocumentor\Descriptor\Collection