Skip to content

Commit 21feb61

Browse files
committed
Add missing DocBlock (info).
1 parent 280a3ce commit 21feb61

File tree

2 files changed

+29
-2
lines changed

2 files changed

+29
-2
lines changed

src/phpDocumentor/Reflection/DocBlock.php

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -303,6 +303,24 @@ public function getLongDescription()
303303
}
304304

305305
/**
306+
* Returns whether this DocBlock is the start of a Template section.
307+
*
308+
* A Docblock may serve as template for a series of subsequent DocBlocks. This is indicated by a special marker
309+
* (`#@+`) that is appended directly after the opening `/**` of a DocBlock.
310+
*
311+
* An example of such an opening is:
312+
*
313+
* ```
314+
* /**#@+
315+
* * My DocBlock
316+
* * /
317+
* ```
318+
*
319+
* The description and tags (not the summary!) are copied onto all subsequent DocBlocks and also applied to all
320+
* elements that follow until another DocBlock is found that contains the closing marker (`#@-`).
321+
*
322+
* @see self::isTemplateEnd() for the check whether a closing marker was provided.
323+
*
306324
* @return boolean
307325
*/
308326
public function isTemplateStart()
@@ -311,6 +329,10 @@ public function isTemplateStart()
311329
}
312330

313331
/**
332+
* Returns whether this DocBlock is the end of a Template section.
333+
*
334+
* @see self::isTemplateStart() for a more complete description of the Docblock Template functionality.
335+
*
314336
* @return boolean
315337
*/
316338
public function isTemplateEnd()

tests/phpDocumentor/Reflection/DocBlockTest.php

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,7 @@ public function testConstruct()
7171

7272
/**
7373
* @covers \phpDocumentor\Reflection\DocBlock::splitDocBlock
74-
* @group test
75-
*
74+
*
7675
* @return void
7776
*/
7877
public function testConstructWithTagsOnly()
@@ -92,6 +91,9 @@ public function testConstructWithTagsOnly()
9291
$this->assertFalse($object->hasTag('category'));
9392
}
9493

94+
/**
95+
* @covers \phpDocumentor\Reflection\DocBlock::isTemplateStart
96+
*/
9597
public function testIfStartOfTemplateIsDiscovered()
9698
{
9799
$fixture = <<<DOCBLOCK
@@ -110,6 +112,9 @@ public function testIfStartOfTemplateIsDiscovered()
110112
$this->assertTrue($object->isTemplateStart());
111113
}
112114

115+
/**
116+
* @covers \phpDocumentor\Reflection\DocBlock::isTemplateEnd
117+
*/
113118
public function testIfEndOfTemplateIsDiscovered()
114119
{
115120
$fixture = <<<DOCBLOCK

0 commit comments

Comments
 (0)