Doc updates and fixes.

This commit is contained in:
Vasil Rangelov
2012-11-13 21:50:56 +02:00
parent 878e24d40d
commit 3bfb48da76
6 changed files with 11 additions and 15 deletions
+3 -6
View File
@@ -46,11 +46,8 @@ class DocBlock implements \Reflector
* Parses the given docblock and populates the member fields. * Parses the given docblock and populates the member fields.
* *
* The constructor may also receive namespace information such as the * The constructor may also receive namespace information such as the
* current namespace and aliases. This information is used in the * current namespace and aliases. This information is used by some tags
* {@link expandType()} method to transform a relative Type into a FQCN. * (e.g. @return, @param, etc.) to turn a relative Type into a FQCN.
*
* For example the param and return tags use this to expand their type
* information.
* *
* @param \Reflector|string $docblock A docblock comment (including * @param \Reflector|string $docblock A docblock comment (including
* asterisks) or reflector supporting the getDocComment method. * 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. * an empty array is returned.
* *
* @param string $name String to search by. * @param string $name String to search by.
@@ -34,8 +34,7 @@ class Description implements \Reflector
protected $docblock = null; protected $docblock = null;
/** /**
* Parses the string for inline tags and if the Markdown class is included; * Populates the fields of a description.
* format the found text.
* *
* @param string $content The DocBlock contents without asterisks. * @param string $content The DocBlock contents without asterisks.
* @param DocBlock $docblock The DocBlock which this description belongs to. * @param DocBlock $docblock The DocBlock which this description belongs to.
@@ -13,7 +13,7 @@
namespace phpDocumentor\Reflection\DocBlock; namespace phpDocumentor\Reflection\DocBlock;
/** /**
* Test class for phpDocumentor\Reflection\DocBlock\Description * Test class for \phpDocumentor\Reflection\DocBlock\Description
* *
* @author Vasil Rangelov <[email protected]> * @author Vasil Rangelov <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
@@ -13,7 +13,7 @@
namespace phpDocumentor\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Test class for \phpDocumentor\Reflection\DocBlock\ParamTag. * Test class for \phpDocumentor\Reflection\DocBlock\ParamTag
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
@@ -13,7 +13,7 @@
namespace phpDocumentor\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Test class for \phpDocumentor\Reflection\DocBlock\ReturnTag. * Test class for \phpDocumentor\Reflection\DocBlock\ReturnTag
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
@@ -1,6 +1,6 @@
<?php <?php
/** /**
* phpDocumentor Return tag test. * phpDocumentor Throws tag test.
* *
* PHP version 5.3 * PHP version 5.3
* *
@@ -13,7 +13,7 @@
namespace phpDocumentor\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Test class for \phpDocumentor\Reflection\DocBlock\ReturnTag. * Test class for \phpDocumentor\Reflection\DocBlock\ThrowsTag
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @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 class ThrowsTagTest extends \PHPUnit_Framework_TestCase
{ {
/** /**
* Test that the \phpDocumentor\Reflection\DocBlock\Tag\ReturnTag can * Test that the \phpDocumentor\Reflection\DocBlock\Tag\ThrowsTag can
* understand the @return DocBlock. * understand the @throws DocBlock.
* *
* @param string $type * @param string $type
* @param string $content * @param string $content