Updated tag doc comments.

This commit is contained in:
Vasil Rangelov
2012-11-10 14:18:40 +02:00
parent 8b9591a7c5
commit 0ba0ad6b42
13 changed files with 21 additions and 21 deletions
@@ -32,7 +32,7 @@ class AuthorTag extends Tag
/**
* Parses a tag and populates the member variables.
*
* @param string $type Name of the tag.
* @param string $type Tag identifier for this tag (should be 'author').
* @param string $content The contents of the given tag.
*/
public function __construct($type, $content)
@@ -29,8 +29,8 @@ class LinkTag extends Tag
/**
* Parses a tag and populates the member variables.
*
* @param string $type Tag type
* @param string $content Content of the tag
* @param string $type Tag identifier for this tag (should be 'link').
* @param string $content The contents of the given tag.
*/
public function __construct($type, $content)
{
@@ -13,7 +13,7 @@
namespace phpDocumentor\Reflection\DocBlock\Tag;
/**
* Reflection class for a {@method} in a Docblock.
* Reflection class for a @method in a Docblock.
*
* @author Mike van Riel <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT
@@ -31,8 +31,8 @@ class MethodTag extends ParamTag
/**
* Parses a tag and populates the member variables.
*
* @param string $type Tag identifier for this tag (should be 'return')
* @param string $content Contents for this tag.
* @param string $type Tag identifier for this tag (should be 'method').
* @param string $content The contents of the given tag.
*/
public function __construct($type, $content)
{
@@ -15,7 +15,7 @@ namespace phpDocumentor\Reflection\DocBlock\Tag;
use phpDocumentor\Reflection\DocBlock\Tag;
/**
* Reflection class for a {@param} tag in a Docblock.
* Reflection class for a @param tag in a Docblock.
*
* @author Mike van Riel <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT
@@ -34,7 +34,7 @@ class ParamTag extends Tag
/**
* Parses a tag and populates the member variables.
*
* @param string $type Tag identifier for this tag (should be 'param')
* @param string $type Tag identifier for this tag (should be 'param').
* @param string $content Contents for this tag.
*/
public function __construct($type, $content)
@@ -13,7 +13,7 @@
namespace phpDocumentor\Reflection\DocBlock\Tag;
/**
* Reflection class for a {@property} tag in a Docblock.
* Reflection class for a @property-read tag in a Docblock.
*
* @author Mike van Riel <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT
@@ -13,7 +13,7 @@
namespace phpDocumentor\Reflection\DocBlock\Tag;
/**
* Reflection class for a {@property} tag in a Docblock.
* Reflection class for a @property tag in a Docblock.
*
* @author Mike van Riel <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT
@@ -13,7 +13,7 @@
namespace phpDocumentor\Reflection\DocBlock\Tag;
/**
* Reflection class for a {@property} tag in a Docblock.
* Reflection class for a @property-write tag in a Docblock.
*
* @author Mike van Riel <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT
@@ -13,7 +13,7 @@
namespace phpDocumentor\Reflection\DocBlock\Tag;
/**
* Reflection class for a {@return} tag in a Docblock.
* Reflection class for a @return tag in a Docblock.
*
* @author Mike van Riel <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT
@@ -27,7 +27,7 @@ class ReturnTag extends ParamTag
/**
* Parses a tag and populates the member variables.
*
* @param string $type Tag identifier for this tag (should be 'return')
* @param string $type Tag identifier for this tag (should be 'return').
* @param string $content Contents for this tag.
*/
public function __construct($type, $content)
@@ -15,7 +15,7 @@ namespace phpDocumentor\Reflection\DocBlock\Tag;
use phpDocumentor\Reflection\DocBlock\Tag;
/**
* Reflection class for a {@see} tag in a Docblock.
* Reflection class for a @see tag in a Docblock.
*
* @author Mike van Riel <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT
@@ -29,7 +29,7 @@ class SeeTag extends Tag
/**
* Parses a tag and populates the member variables.
*
* @param string $type Tag identifier for this tag (should be 'return')
* @param string $type Tag identifier for this tag (should be 'see').
* @param string $content Contents for this tag.
*/
public function __construct($type, $content)
@@ -24,10 +24,10 @@ namespace phpDocumentor\Reflection\DocBlock\Tag;
class ThrowTag extends ThrowsTag
{
/**
* Sets the type to {@throws} and lets parent parse the tag and populates the
* Sets the type to @throws and lets parent parse the tag and populates the
* member variables.
*
* @param string $type Tag identifier for this tag (should be 'return')
* @param string $type Tag identifier for this tag (should be 'throw').
* @param string $content Contents for this tag.
*/
public function __construct($type, $content)
@@ -13,7 +13,7 @@
namespace phpDocumentor\Reflection\DocBlock\Tag;
/**
* Reflection class for a {@throws} tag in a Docblock.
* Reflection class for a @throws tag in a Docblock.
*
* @author Mike van Riel <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT
@@ -13,7 +13,7 @@
namespace phpDocumentor\Reflection\DocBlock\Tag;
/**
* Reflection class for a {@uses} tag in a Docblock.
* Reflection class for a @uses tag in a Docblock.
*
* @author Mike van Riel <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT
@@ -13,7 +13,7 @@
namespace phpDocumentor\Reflection\DocBlock\Tag;
/**
* Reflection class for a {@var} tag in a Docblock.
* Reflection class for a @var tag in a Docblock.
*
* @author Mike van Riel <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT
@@ -24,7 +24,7 @@ class VarTag extends ParamTag
/**
* Parses a tag and populates the member variables.
*
* @param string $type Tag identifier for this tag (should be 'return')
* @param string $type Tag identifier for this tag (should be 'var').
* @param string $content Contents for this tag.
*/
public function __construct($type, $content)