mirror of
https://github.com/barryvdh/ReflectionDocBlock.git
synced 2026-08-18 18:13:13 +00:00
Add missing DocBlock (info).
This commit is contained in:
@@ -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
|
* @return boolean
|
||||||
*/
|
*/
|
||||||
public function isTemplateStart()
|
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
|
* @return boolean
|
||||||
*/
|
*/
|
||||||
public function isTemplateEnd()
|
public function isTemplateEnd()
|
||||||
|
|||||||
@@ -71,7 +71,6 @@ DOCBLOCK;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @covers \phpDocumentor\Reflection\DocBlock::splitDocBlock
|
* @covers \phpDocumentor\Reflection\DocBlock::splitDocBlock
|
||||||
* @group test
|
|
||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
@@ -92,6 +91,9 @@ DOCBLOCK;
|
|||||||
$this->assertFalse($object->hasTag('category'));
|
$this->assertFalse($object->hasTag('category'));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock::isTemplateStart
|
||||||
|
*/
|
||||||
public function testIfStartOfTemplateIsDiscovered()
|
public function testIfStartOfTemplateIsDiscovered()
|
||||||
{
|
{
|
||||||
$fixture = <<<DOCBLOCK
|
$fixture = <<<DOCBLOCK
|
||||||
@@ -110,6 +112,9 @@ DOCBLOCK;
|
|||||||
$this->assertTrue($object->isTemplateStart());
|
$this->assertTrue($object->isTemplateStart());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock::isTemplateEnd
|
||||||
|
*/
|
||||||
public function testIfEndOfTemplateIsDiscovered()
|
public function testIfEndOfTemplateIsDiscovered()
|
||||||
{
|
{
|
||||||
$fixture = <<<DOCBLOCK
|
$fixture = <<<DOCBLOCK
|
||||||
|
|||||||
Reference in New Issue
Block a user