PHP Class paramTag

Inheritance: extends Tag

Public Properties

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

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

Return true if this Taglet should be outputted even if it has no text content.

public displayEmpty ( ) : boolean
return	boolean

Get display name of this tag.

public displayName ( ) : str
return	str

Return true if this Taglet is used in constructor documentation.

public inConstructor ( ) : boolean
return	boolean

Return true if this Taglet is used in field documentation.

public inField ( ) : boolean
return	boolean

Return true if this Taglet is used in method documentation.

public inMethod ( ) : boolean
return	boolean

Return true if this Taglet is used in overview documentation.

public inOverview ( ) : boolean
return	boolean

Return true if this Taglet is used in package documentation.

public inPackage ( ) : boolean
return	boolean

Return true if this Taglet is used in class or interface documentation.

public inType ( ) : boolean
return	boolean

Return true if this Taglet is an inline tag.

public isInlineTag ( ) : boolean
return	boolean

Constructor

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

The variable name of the parameter

public str $_var
return	str