MethodDescriptor

Extends \phpDocumentor\Descriptor\TagDescriptor

Base class for any tag descriptor and used when a tag has no specific descriptor.

package

Default

Methods

Initializes the tag by setting the name and errors,

__construct(string $name) 
inherited

Arguments

$name

string

getArguments

getArguments() : mixed

Response

mixed

Returns the description for this tag,

getDescription() : string
inherited

Response

string

Returns all errors associated with this tag.

getErrors() : \phpDocumentor\Descriptor\Collection
inherited

getMethodName

getMethodName() : string

Response

string

Returns the name for this tag.

getName() : string
inherited

Response

string

getResponse

getResponse() : \phpDocumentor\Descriptor\Tag\ReturnDescriptor

isStatic

isStatic() : boolean

Response

boolean

setArguments

setArguments(mixed $arguments) 

Arguments

$arguments

mixed

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

setMethodName

setMethodName(string $methodName) 

Arguments

$methodName

string

Sets the name for this tag.

setName(string $name) : void
inherited

Arguments

$name

string

setResponse

setResponse(mixed $response) 

Arguments

$response

mixed

setStatic

setStatic(boolean $static) 

Arguments

$static

boolean

Properties

methodName

methodName : 

Type(s)

arguments

arguments : 

Type(s)

response

response : 

Type(s)

static

static : boolean
var

Type(s)

boolean

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