PHP Класс seeTag

Наследование: extends Tag
Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
$_link str The link.

Открытые методы

Метод Описание
_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.

Описание методов

_linkText() публичный Метод

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

_resolveLink() публичный Метод

Turn the objects link text into a link to the element it refers to.
public _resolveLink ( ) : ProgramElementDoc
Результат ProgramElementDoc

displayName() публичный Метод

Get display name of this tag.
public displayName ( ) : str
Результат str

inConstructor() публичный Метод

Return true if this Taglet is used in constructor documentation.
public inConstructor ( ) : boolean
Результат boolean

inField() публичный Метод

Return true if this Taglet is used in field documentation.
public inField ( ) : boolean
Результат boolean

inMethod() публичный Метод

Return true if this Taglet is used in method documentation.
public inMethod ( ) : boolean
Результат boolean

inOverview() публичный Метод

Return true if this Taglet is used in overview documentation.
public inOverview ( ) : boolean
Результат boolean

inPackage() публичный Метод

Return true if this Taglet is used in package documentation.
public inPackage ( ) : boolean
Результат boolean

inType() публичный Метод

Return true if this Taglet is used in class or interface documentation.
public inType ( ) : boolean
Результат boolean

isInlineTag() публичный Метод

Return true if this Taglet is an inline tag.
public isInlineTag ( ) : boolean
Результат boolean

seeTag() публичный Метод

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

text() публичный Метод

Get value of this tag.
public text ( $doclet ) : str
Результат str

Описание свойств

$_link публичное свойство

The link.
public str $_link
Результат str