Skip to content

Commit 0ba0ad6

Browse files
committed
Updated tag doc comments.
1 parent 8b9591a commit 0ba0ad6

File tree

13 files changed

+21
-21
lines changed

13 files changed

+21
-21
lines changed

src/phpDocumentor/Reflection/DocBlock/Tag/AuthorTag.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ class AuthorTag extends Tag
3232
/**
3333
* Parses a tag and populates the member variables.
3434
*
35-
* @param string $type Name of the tag.
35+
* @param string $type Tag identifier for this tag (should be 'author').
3636
* @param string $content The contents of the given tag.
3737
*/
3838
public function __construct($type, $content)

src/phpDocumentor/Reflection/DocBlock/Tag/LinkTag.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ class LinkTag extends Tag
2929
/**
3030
* Parses a tag and populates the member variables.
3131
*
32-
* @param string $type Tag type
33-
* @param string $content Content of the tag
32+
* @param string $type Tag identifier for this tag (should be 'link').
33+
* @param string $content The contents of the given tag.
3434
*/
3535
public function __construct($type, $content)
3636
{

src/phpDocumentor/Reflection/DocBlock/Tag/MethodTag.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
namespace phpDocumentor\Reflection\DocBlock\Tag;
1414

1515
/**
16-
* Reflection class for a {@method} in a Docblock.
16+
* Reflection class for a @method in a Docblock.
1717
*
1818
* @author Mike van Riel <[email protected]>
1919
* @license http://www.opensource.org/licenses/mit-license.php MIT
@@ -31,8 +31,8 @@ class MethodTag extends ParamTag
3131
/**
3232
* Parses a tag and populates the member variables.
3333
*
34-
* @param string $type Tag identifier for this tag (should be 'return')
35-
* @param string $content Contents for this tag.
34+
* @param string $type Tag identifier for this tag (should be 'method').
35+
* @param string $content The contents of the given tag.
3636
*/
3737
public function __construct($type, $content)
3838
{

src/phpDocumentor/Reflection/DocBlock/Tag/ParamTag.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
use phpDocumentor\Reflection\DocBlock\Tag;
1616

1717
/**
18-
* Reflection class for a {@param} tag in a Docblock.
18+
* Reflection class for a @param tag in a Docblock.
1919
*
2020
* @author Mike van Riel <[email protected]>
2121
* @license http://www.opensource.org/licenses/mit-license.php MIT
@@ -34,7 +34,7 @@ class ParamTag extends Tag
3434
/**
3535
* Parses a tag and populates the member variables.
3636
*
37-
* @param string $type Tag identifier for this tag (should be 'param')
37+
* @param string $type Tag identifier for this tag (should be 'param').
3838
* @param string $content Contents for this tag.
3939
*/
4040
public function __construct($type, $content)

src/phpDocumentor/Reflection/DocBlock/Tag/PropertyReadTag.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
namespace phpDocumentor\Reflection\DocBlock\Tag;
1414

1515
/**
16-
* Reflection class for a {@property} tag in a Docblock.
16+
* Reflection class for a @property-read tag in a Docblock.
1717
*
1818
* @author Mike van Riel <[email protected]>
1919
* @license http://www.opensource.org/licenses/mit-license.php MIT

src/phpDocumentor/Reflection/DocBlock/Tag/PropertyTag.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
namespace phpDocumentor\Reflection\DocBlock\Tag;
1414

1515
/**
16-
* Reflection class for a {@property} tag in a Docblock.
16+
* Reflection class for a @property tag in a Docblock.
1717
*
1818
* @author Mike van Riel <[email protected]>
1919
* @license http://www.opensource.org/licenses/mit-license.php MIT

src/phpDocumentor/Reflection/DocBlock/Tag/PropertyWriteTag.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
namespace phpDocumentor\Reflection\DocBlock\Tag;
1414

1515
/**
16-
* Reflection class for a {@property} tag in a Docblock.
16+
* Reflection class for a @property-write tag in a Docblock.
1717
*
1818
* @author Mike van Riel <[email protected]>
1919
* @license http://www.opensource.org/licenses/mit-license.php MIT

src/phpDocumentor/Reflection/DocBlock/Tag/ReturnTag.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
namespace phpDocumentor\Reflection\DocBlock\Tag;
1414

1515
/**
16-
* Reflection class for a {@return} tag in a Docblock.
16+
* Reflection class for a @return tag in a Docblock.
1717
*
1818
* @author Mike van Riel <[email protected]>
1919
* @license http://www.opensource.org/licenses/mit-license.php MIT
@@ -27,7 +27,7 @@ class ReturnTag extends ParamTag
2727
/**
2828
* Parses a tag and populates the member variables.
2929
*
30-
* @param string $type Tag identifier for this tag (should be 'return')
30+
* @param string $type Tag identifier for this tag (should be 'return').
3131
* @param string $content Contents for this tag.
3232
*/
3333
public function __construct($type, $content)

src/phpDocumentor/Reflection/DocBlock/Tag/SeeTag.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
use phpDocumentor\Reflection\DocBlock\Tag;
1616

1717
/**
18-
* Reflection class for a {@see} tag in a Docblock.
18+
* Reflection class for a @see tag in a Docblock.
1919
*
2020
* @author Mike van Riel <[email protected]>
2121
* @license http://www.opensource.org/licenses/mit-license.php MIT
@@ -29,7 +29,7 @@ class SeeTag extends Tag
2929
/**
3030
* Parses a tag and populates the member variables.
3131
*
32-
* @param string $type Tag identifier for this tag (should be 'return')
32+
* @param string $type Tag identifier for this tag (should be 'see').
3333
* @param string $content Contents for this tag.
3434
*/
3535
public function __construct($type, $content)

src/phpDocumentor/Reflection/DocBlock/Tag/ThrowTag.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@
2424
class ThrowTag extends ThrowsTag
2525
{
2626
/**
27-
* Sets the type to {@throws} and lets parent parse the tag and populates the
27+
* Sets the type to @throws and lets parent parse the tag and populates the
2828
* member variables.
2929
*
30-
* @param string $type Tag identifier for this tag (should be 'return')
30+
* @param string $type Tag identifier for this tag (should be 'throw').
3131
* @param string $content Contents for this tag.
3232
*/
3333
public function __construct($type, $content)

0 commit comments

Comments
 (0)