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

Set the text portion of the doc block.

Sets the text portion (short and long description combined) of the doc block.

Parameters

string $docblock The new text portion of the doc block.:

Return value

$this This doc block.

File

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

Class

DocBlock

Parses the DocBlock for any structure.

Namespace

phpDocumentor\Reflection

Code

public function setText($comment) {
  list(, $short, $long) = $this
    ->splitDocBlock($comment);
  $this->short_description = $short;
  $this->long_description = new DocBlock\Description($long, $this);
  return $this;
}