public function DocBlock::isTemplateStart in Zircon Profile 8

Same name and namespace in other branches

1. 8.0 vendor/phpdocumentor/reflection-docblock/src/phpDocumentor/Reflection/DocBlock.php \phpDocumentor\Reflection\DocBlock::isTemplateStart()

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 (`#@-`).

Return value

boolean

See also

self::isTemplateEnd() for the check whether a closing marker was provided.

File

vendor/phpdocumentor/reflection-docblock/src/phpDocumentor/Reflection/DocBlock.php, line 326

Class

DocBlock

Parses the DocBlock for any structure.

Namespace

phpDocumentor\Reflection

Code

public function isTemplateStart() {
  return $this->isTemplateStart;
}