PHP Class seeTag

Inheritance: extends Tag
Afficher le fichier Open project: peej/phpdoctor

Méthodes publiques

Свойство Type Description
$_link str The link.

Méthodes publiques

Méthode 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 méthode

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

_resolveLink() public méthode

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

displayName() public méthode

Get display name of this tag.
public displayName ( ) : str
Résultat str

inConstructor() public méthode

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

inField() public méthode

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

inMethod() public méthode

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

inOverview() public méthode

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

inPackage() public méthode

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

inType() public méthode

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

isInlineTag() public méthode

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

seeTag() public méthode

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

text() public méthode

Get value of this tag.
public text ( $doclet ) : str
Résultat str

Property Details

$_link public_oe property

The link.
public str $_link
Résultat str