PHP Class PhpCsFixer\DocBlock\Tag

Author: Graham Campbell ([email protected])
Show file Open project: friendsofphp/php-cs-fixer Class Usage Examples

Public Methods

Method Description
__construct ( PhpCsFixer\DocBlock\Line $line ) Create a new tag instance.
getName ( ) : string Get the tag name.
setName ( string $name ) Set the tag name.
valid ( ) : boolean Is the tag a known tag?

Method Details

__construct() public method

Create a new tag instance.
public __construct ( PhpCsFixer\DocBlock\Line $line )
$line PhpCsFixer\DocBlock\Line

getName() public method

This may be "param", or "return", etc.
public getName ( ) : string
return string

setName() public method

This will also be persisted to the upsteam line and annotation.
public setName ( string $name )
$name string

valid() public method

This is defined by if it exists in the proposed PSR PHPDoc standard.
public valid ( ) : boolean
return boolean