public function DocBlock::getShortDescription 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::getShortDescription()

Returns the opening line or also known as short description.

Return value

string

1 call to DocBlock::getShortDescription()

DocBlock::getText in vendor/phpdocumentor/reflection-docblock/src/phpDocumentor/Reflection/DocBlock.php

Gets the text portion of the doc block.

File

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

Class

DocBlock

Parses the DocBlock for any structure.

Namespace

phpDocumentor\Reflection

Code

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