From d73444f859f901800292ee8363ad41c40be7a8e7 Mon Sep 17 00:00:00 2001 From: Vasil Rangelov Date: Sat, 10 Nov 2012 23:45:28 +0200 Subject: [PATCH] Minor doc fixes. --- src/phpDocumentor/Reflection/DocBlock.php | 9 ++++++--- tests/phpDocumentor/Reflection/DocBlock/TagTest.php | 2 ++ .../Reflection/DocBlock/Type/CollectionTest.php | 8 ++++---- tests/phpDocumentor/Reflection/DocBlockTest.php | 12 ++++++++++++ 4 files changed, 24 insertions(+), 7 deletions(-) diff --git a/src/phpDocumentor/Reflection/DocBlock.php b/src/phpDocumentor/Reflection/DocBlock.php index 921e829..fa2a4cb 100644 --- a/src/phpDocumentor/Reflection/DocBlock.php +++ b/src/phpDocumentor/Reflection/DocBlock.php @@ -39,7 +39,7 @@ class DocBlock implements \Reflector /** @var string the current namespace */ protected $namespace = '\\'; - /** @var string[] List of namespace aliases => Fully Qualified Namespace */ + /** @var array List of namespace aliases => Fully Qualified Namespace */ protected $namespace_aliases = array(); /** @@ -56,7 +56,7 @@ class DocBlock implements \Reflector * asterisks) or reflector supporting the getDocComment method. * @param string $namespace The namespace where this * DocBlock resides in; defaults to `\`. - * @param string[] $namespace_aliases A list of namespace aliases + * @param array $namespace_aliases A list of namespace aliases * as provided by the `use` keyword; the key of the array is the alias * name or last part of the alias array if no alias name is provided. * @@ -331,13 +331,16 @@ class DocBlock implements \Reflector } /** - * @return string + * @return string The namespace where this DocBlock resides in. */ public function getNamespace() { return $this->namespace; } + /** + * @return array List of namespace aliases => Fully Qualified Namespace. + */ public function getNamespaceAliases() { return $this->namespace_aliases; diff --git a/tests/phpDocumentor/Reflection/DocBlock/TagTest.php b/tests/phpDocumentor/Reflection/DocBlock/TagTest.php index f50c6c7..31a3fa9 100644 --- a/tests/phpDocumentor/Reflection/DocBlock/TagTest.php +++ b/tests/phpDocumentor/Reflection/DocBlock/TagTest.php @@ -25,6 +25,8 @@ class TagTest extends \PHPUnit_Framework_TestCase /** * @expectedException \InvalidArgumentException + * + * @return void */ public function testInvalidTagLine() { diff --git a/tests/phpDocumentor/Reflection/DocBlock/Type/CollectionTest.php b/tests/phpDocumentor/Reflection/DocBlock/Type/CollectionTest.php index ffce80d..0b6fa91 100644 --- a/tests/phpDocumentor/Reflection/DocBlock/Type/CollectionTest.php +++ b/tests/phpDocumentor/Reflection/DocBlock/Type/CollectionTest.php @@ -135,8 +135,8 @@ class CollectionTest extends \PHPUnit_Framework_TestCase } /** - * @param $fixture - * @param $expected + * @param string $fixture + * @param array $expected * * @dataProvider provideTypesToExpand * @covers phpDocumentor\Reflection\DocBlock\Type\Collection::add @@ -154,8 +154,8 @@ class CollectionTest extends \PHPUnit_Framework_TestCase } /** - * @param $fixture - * @param $expected + * @param string $fixture + * @param array $expected * * @dataProvider provideTypesToExpandWithoutNamespace * @covers phpDocumentor\Reflection\DocBlock\Type\Collection::add diff --git a/tests/phpDocumentor/Reflection/DocBlockTest.php b/tests/phpDocumentor/Reflection/DocBlockTest.php index b6179a2..c0a1df6 100644 --- a/tests/phpDocumentor/Reflection/DocBlockTest.php +++ b/tests/phpDocumentor/Reflection/DocBlockTest.php @@ -100,6 +100,8 @@ DOCBLOCK; /** * @covers \phpDocumentor\Reflection\DocBlock::__construct + * + * @return void */ public function testConstructFromReflector() { @@ -119,6 +121,8 @@ DOCBLOCK; /** * @expectedException \InvalidArgumentException + * + * @return void */ public function testExceptionOnInvalidObject() { @@ -187,6 +191,8 @@ DOCBLOCK; /** * @depends testConstructFromReflector * @covers \phpDocumentor\Reflection\DocBlock::getTagsByName + * + * @return void */ public function testGetTagsByNameZeroAndOneMatch() { @@ -198,6 +204,8 @@ DOCBLOCK; /** * @depends testConstructWithTagsOnly * @covers \phpDocumentor\Reflection\DocBlock::parseTags + * + * @return void */ public function testParseMultilineTag() { @@ -214,6 +222,8 @@ DOCBLOCK; /** * @depends testConstructWithTagsOnly * @covers \phpDocumentor\Reflection\DocBlock::parseTags + * + * @return void */ public function testParseMultilineTagWithLineBreaks() { @@ -232,6 +242,8 @@ DOCBLOCK; /** * @depends testConstructWithTagsOnly * @covers \phpDocumentor\Reflection\DocBlock::getTagsByName + * + * @return void */ public function testGetTagsByNameMultipleMatch() {