PHP Class seeTag

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

Public Properties

Property Type Description
$_link str The link.

Public Methods

Method Description
_linkText ( $link, $doclet ) Generate the text to go into the seeTag link
_resolveLink ( ) : ProgramElementDoc Turn the objects link text into a link to the element it refers to.
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.
seeTag ( $text, &$data, &$root ) Constructor
text ( $doclet ) : str Get value of this tag.

Method Details

_linkText() public method

Generate the text to go into the seeTag link
public _linkText ( $link, $doclet )

_resolveLink() public method

Turn the objects link text into a link to the element it refers to.
public _resolveLink ( ) : ProgramElementDoc
return ProgramElementDoc

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

seeTag() public method

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

text() public method

Get value of this tag.
public text ( $doclet ) : str
return str

Property Details

$_link public property

The link.
public str $_link
return str