PHP Class paramTag

Inheritance: extends Tag
Mostra file Open project: peej/phpdoctor

Public Properties

Property Type Description
$_var str The variable name of the parameter

Public Methods

Method Description
displayEmpty ( ) : boolean Return true if this Taglet should be outputted even if it has no text content.
displayName ( ) : str Get display name of this tag.
inConstructor ( ) : boolean Return true if this Taglet is used in constructor documentation.
inField ( ) : boolean Return true if this Taglet is used in field documentation.
inMethod ( ) : boolean Return true if this Taglet is used in method documentation.
inOverview ( ) : boolean Return true if this Taglet is used in overview documentation.
inPackage ( ) : boolean Return true if this Taglet is used in package documentation.
inType ( ) : boolean Return true if this Taglet is used in class or interface documentation.
isInlineTag ( ) : boolean Return true if this Taglet is an inline tag.
paramTag ( $text, &$data, &$root ) Constructor

Method Details

displayEmpty() public method

Return true if this Taglet should be outputted even if it has no text content.
public displayEmpty ( ) : boolean
return boolean

displayName() public method

Get display name of this tag.
public displayName ( ) : str
return str

inConstructor() public method

Return true if this Taglet is used in constructor documentation.
public inConstructor ( ) : boolean
return boolean

inField() public method

Return true if this Taglet is used in field documentation.
public inField ( ) : boolean
return boolean

inMethod() public method

Return true if this Taglet is used in method documentation.
public inMethod ( ) : boolean
return boolean

inOverview() public method

Return true if this Taglet is used in overview documentation.
public inOverview ( ) : boolean
return boolean

inPackage() public method

Return true if this Taglet is used in package documentation.
public inPackage ( ) : boolean
return boolean

inType() public method

Return true if this Taglet is used in class or interface documentation.
public inType ( ) : boolean
return boolean

isInlineTag() public method

Return true if this Taglet is an inline tag.
public isInlineTag ( ) : boolean
return boolean

paramTag() public method

Constructor
public paramTag ( $text, &$data, &$root )

Property Details

$_var public_oe property

The variable name of the parameter
public str $_var
return str