PHP Class inheritDocTag

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

Public Methods

Method Description
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.
inheritDocTag ( $text, &$data, &$root ) Constructor
isInlineTag ( ) : boolean Return true if this Taglet is an inline tag.
text ( $formatter ) : str Get text from super element

Method Details

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

inheritDocTag() public method

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

isInlineTag() public method

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

text() public method

Get text from super element
public text ( $formatter ) : str
return str