FunctionyDeclaration
A thing and its corresponding doc block
Instance Methods
| Returns | Signature and Description |
|---|---|
ConstMap<string,ParameterTag> | Gets the parameter tags. |
?TypedTag | Gets the returns tag. |
ConstVector<TypedTag> | Gets the list of exceptions thrown. |
ScannedFunctionAbstract | getToken()Gets the scanned token. |
Method Details
getParameterTags
abstract public function
getParameterTags()Gets the parameter tags.
| Type | Description |
|---|---|
ConstMap<string,ParameterTag> | The parameter tags |
getReturnsTag
abstract public function
getReturnsTag()Gets the returns tag.
| Type | Description |
|---|---|
?TypedTag | The return tag |
getThrowsTags
abstract public function
getThrowsTags()Gets the list of exceptions thrown.
| Type | Description |
|---|---|
ConstVector<TypedTag> | The throws tags |
getToken
abstract public function
getToken()Gets the scanned token.
| Type | Description |
|---|---|
ScannedFunctionAbstract | The scanned token |