Minor doc fixes.

This commit is contained in:
Vasil Rangelov
2012-11-10 23:45:28 +02:00
parent a868c60f8e
commit fedcd8cf49
4 changed files with 24 additions and 7 deletions
+6 -3
View File
@@ -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;
@@ -25,6 +25,8 @@ class TagTest extends \PHPUnit_Framework_TestCase
/**
* @expectedException \InvalidArgumentException
*
* @return void
*/
public function testInvalidTagLine()
{
@@ -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
@@ -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()
{