From 3bfb48da76f0f11a79c6337863a4dde738d19cf4 Mon Sep 17 00:00:00 2001 From: Vasil Rangelov Date: Tue, 13 Nov 2012 21:50:56 +0200 Subject: [PATCH] Doc updates and fixes. --- src/phpDocumentor/Reflection/DocBlock.php | 9 +++------ src/phpDocumentor/Reflection/DocBlock/Description.php | 3 +-- .../Reflection/DocBlock/DescriptionTest.php | 2 +- .../Reflection/DocBlock/Tag/ParamTagTest.php | 2 +- .../Reflection/DocBlock/Tag/ReturnTagTest.php | 2 +- .../Reflection/DocBlock/Tag/ThrowsTagTest.php | 8 ++++---- 6 files changed, 11 insertions(+), 15 deletions(-) diff --git a/src/phpDocumentor/Reflection/DocBlock.php b/src/phpDocumentor/Reflection/DocBlock.php index b55b470..65822d1 100644 --- a/src/phpDocumentor/Reflection/DocBlock.php +++ b/src/phpDocumentor/Reflection/DocBlock.php @@ -46,11 +46,8 @@ class DocBlock implements \Reflector * Parses the given docblock and populates the member fields. * * The constructor may also receive namespace information such as the - * current namespace and aliases. This information is used in the - * {@link expandType()} method to transform a relative Type into a FQCN. - * - * For example the param and return tags use this to expand their type - * information. + * current namespace and aliases. This information is used by some tags + * (e.g. @return, @param, etc.) to turn a relative Type into a FQCN. * * @param \Reflector|string $docblock A docblock comment (including * asterisks) or reflector supporting the getDocComment method. @@ -260,7 +257,7 @@ class DocBlock implements \Reflector } /** - * Returns an array of tags matching the given name; if no tags are found + * Returns an array of tags matching the given name. If no tags are found * an empty array is returned. * * @param string $name String to search by. diff --git a/src/phpDocumentor/Reflection/DocBlock/Description.php b/src/phpDocumentor/Reflection/DocBlock/Description.php index b9cad7d..aac22d5 100644 --- a/src/phpDocumentor/Reflection/DocBlock/Description.php +++ b/src/phpDocumentor/Reflection/DocBlock/Description.php @@ -34,8 +34,7 @@ class Description implements \Reflector protected $docblock = null; /** - * Parses the string for inline tags and if the Markdown class is included; - * format the found text. + * Populates the fields of a description. * * @param string $content The DocBlock contents without asterisks. * @param DocBlock $docblock The DocBlock which this description belongs to. diff --git a/tests/phpDocumentor/Reflection/DocBlock/DescriptionTest.php b/tests/phpDocumentor/Reflection/DocBlock/DescriptionTest.php index 8b48060..a6ca7b3 100644 --- a/tests/phpDocumentor/Reflection/DocBlock/DescriptionTest.php +++ b/tests/phpDocumentor/Reflection/DocBlock/DescriptionTest.php @@ -13,7 +13,7 @@ namespace phpDocumentor\Reflection\DocBlock; /** - * Test class for phpDocumentor\Reflection\DocBlock\Description + * Test class for \phpDocumentor\Reflection\DocBlock\Description * * @author Vasil Rangelov * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) diff --git a/tests/phpDocumentor/Reflection/DocBlock/Tag/ParamTagTest.php b/tests/phpDocumentor/Reflection/DocBlock/Tag/ParamTagTest.php index c0a370c..5d8f554 100644 --- a/tests/phpDocumentor/Reflection/DocBlock/Tag/ParamTagTest.php +++ b/tests/phpDocumentor/Reflection/DocBlock/Tag/ParamTagTest.php @@ -13,7 +13,7 @@ namespace phpDocumentor\Reflection\DocBlock\Tag; /** - * Test class for \phpDocumentor\Reflection\DocBlock\ParamTag. + * Test class for \phpDocumentor\Reflection\DocBlock\ParamTag * * @author Mike van Riel * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) diff --git a/tests/phpDocumentor/Reflection/DocBlock/Tag/ReturnTagTest.php b/tests/phpDocumentor/Reflection/DocBlock/Tag/ReturnTagTest.php index 5eef162..7e701f2 100644 --- a/tests/phpDocumentor/Reflection/DocBlock/Tag/ReturnTagTest.php +++ b/tests/phpDocumentor/Reflection/DocBlock/Tag/ReturnTagTest.php @@ -13,7 +13,7 @@ namespace phpDocumentor\Reflection\DocBlock\Tag; /** - * Test class for \phpDocumentor\Reflection\DocBlock\ReturnTag. + * Test class for \phpDocumentor\Reflection\DocBlock\ReturnTag * * @author Mike van Riel * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) diff --git a/tests/phpDocumentor/Reflection/DocBlock/Tag/ThrowsTagTest.php b/tests/phpDocumentor/Reflection/DocBlock/Tag/ThrowsTagTest.php index 124c469..aaed800 100644 --- a/tests/phpDocumentor/Reflection/DocBlock/Tag/ThrowsTagTest.php +++ b/tests/phpDocumentor/Reflection/DocBlock/Tag/ThrowsTagTest.php @@ -1,6 +1,6 @@ * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) @@ -23,8 +23,8 @@ namespace phpDocumentor\Reflection\DocBlock\Tag; class ThrowsTagTest extends \PHPUnit_Framework_TestCase { /** - * Test that the \phpDocumentor\Reflection\DocBlock\Tag\ReturnTag can - * understand the @return DocBlock. + * Test that the \phpDocumentor\Reflection\DocBlock\Tag\ThrowsTag can + * understand the @throws DocBlock. * * @param string $type * @param string $content