PHPFUI/InstaDoc

CloneableFinalInstantiable

Public
Private

Methods

public __construct(string $summary = '', ?phpDocumentor\Reflection\DocBlock\Description $description = NULL, array $tags = [], ?phpDocumentor\Reflection\Types\Context $context = NULL, ?phpDocumentor\Reflection\Location $location = NULL, bool $isTemplateStart = false, bool $isTemplateEnd = false)

param \DocBlock\Tag[] $tags
param \Types\Context $context The context in which the DocBlock occurs.
param \Location $location The location within the file that this DocBlock occurs in.

public getContext() : ?phpDocumentor\Reflection\Types\Context

Returns the current context.

public getDescription() : phpDocumentor\Reflection\DocBlock\Description

public getLocation() : ?phpDocumentor\Reflection\Location

Returns the current location.

public getSummary() : string

public getTags() : array

Returns the tags for this DocBlock.

return \Tag[]

public getTagsByName(string $name) : array

Returns an array of tags matching the given name. If no tags are found an empty array is returned.

param string $name String to search by.
return \Tag[]

public getTagsWithTypeByName(string $name) : array

Returns an array of tags with type matching the given name. If no tags are found an empty array is returned.

param string $name String to search by.
return \TagWithType[]

public hasTag(string $name) : bool

Checks if a tag of a certain type is present in this DocBlock.

param string $name Tag name to check for.

public isTemplateEnd() : bool

Returns whether this DocBlock is the end of a Template section.

see \self::isTemplateStart()for a more complete description of the Docblock Template functionality.

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 (#@+) that is appended directly after the opening /** of a DocBlock.

An example of such an opening is:

/**#@+
 * My DocBlock
 * /

The description and tags (not the summary!) are copied onto all subsequent DocBlocks and also applied to all elements that follow until another DocBlock is found that contains the closing marker (#@-).