Methods |
public
__construct
(
string
$summary
=
''
,
?
phpDocumentor
|
public
getContext
() : ?
phpDocumentor Returns the current context. |
public
getDescription
() :
phpDocumentor |
public
getLocation
() : ?
phpDocumentor Returns the current location. |
public getSummary () : string |
public
getTags
() :
array
Returns the tags for this DocBlock.
|
public
getTagsByName
(
string
$name
) :
array
Returns an array of tags matching the given name. If no tags are found
|
public
getTagsWithTypeByName
(
string
$name
) :
array
Returns an array of tags with type matching the given name. If no tags are found
|
public
hasTag
(
string
$name
) :
bool
Checks if a tag of a certain type is present in this DocBlock.
|
public
isTemplateEnd
() :
bool
Returns whether this DocBlock is the end of a Template section.
|
public
isTemplateStart
() :
bool
Returns whether this DocBlock is the start of a Template section. A Docblock may serve as template for a series of subsequent DocBlocks. This is indicated by a special marker An example of such an opening is:
The description and tags (not the summary!) are copied onto all subsequent DocBlocks and also applied to all
|
public
removeTag
(
phpDocumentor Remove a tag from this DocBlock.
|
Properties |
private
$context
|
private
$description
|
private
$isTemplateEnd
|
private
$isTemplateStart
|
private
$location
|
private
$summary
|
private
$tags
|
Methods |
private
addTag
(
phpDocumentor Adds a tag to this DocBlock.
|