Add missing DocBlock (info).

This commit is contained in:
Mike van Riel
2014-08-30 11:16:26 +02:00
parent 280a3ce56d
commit 21feb61eb5
2 changed files with 29 additions and 2 deletions
+22
View File
@@ -303,6 +303,24 @@ class DocBlock implements \Reflector
}
/**
* 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 (`#@-`).
*
* @see self::isTemplateEnd() for the check whether a closing marker was provided.
*
* @return boolean
*/
public function isTemplateStart()
@@ -311,6 +329,10 @@ class DocBlock implements \Reflector
}
/**
* Returns whether this DocBlock is the end of a Template section.
*
* @see self::isTemplateStart() for a more complete description of the Docblock Template functionality.
*
* @return boolean
*/
public function isTemplateEnd()
@@ -71,8 +71,7 @@ DOCBLOCK;
/**
* @covers \phpDocumentor\Reflection\DocBlock::splitDocBlock
* @group test
*
*
* @return void
*/
public function testConstructWithTagsOnly()
@@ -92,6 +91,9 @@ DOCBLOCK;
$this->assertFalse($object->hasTag('category'));
}
/**
* @covers \phpDocumentor\Reflection\DocBlock::isTemplateStart
*/
public function testIfStartOfTemplateIsDiscovered()
{
$fixture = <<<DOCBLOCK
@@ -110,6 +112,9 @@ DOCBLOCK;
$this->assertTrue($object->isTemplateStart());
}
/**
* @covers \phpDocumentor\Reflection\DocBlock::isTemplateEnd
*/
public function testIfEndOfTemplateIsDiscovered()
{
$fixture = <<<DOCBLOCK