• Главная
• tag

PHP Класс tag

Показать файл Открыть проект Примеры использования класса

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

Свойство	Тип	Описание
$_name	str	The name of the tag.
$_parent	programElementDoc	Reference to the elements parent.
$_root	rootDoc	Reference to the root element.
$_text	str	The value of the tag as raw data, without any text processing applied.

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

Метод	Описание
_getInlineTags ( $text ) : Tag[]	Parse out inline tags from within a text string
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.
firstSentenceTags ( $formatter ) : Tag[]	Return the first sentence of the comment as tags. Includes inline tags (i.e. {@link reference} tags) but not regular tags. Each section of plain text is represented as a Tag of kind "Text". Inline tags are represented as a SeeTag of kind "link". The sentence ends at the first period that is followed by a space, tab, or a line terminator, at the first tagline, or at closing of a HTML block element ( ).
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.
inlineTags ( $formatter ) : Tag[]	For documentation comment with embedded @link tags, return the array of tags. Within a comment string "This is an example of inline tags for a documentaion comment {@link Doc commentlabel}", where inside the inner braces, the first "Doc" carries exactly the same syntax as a SeeTag and the second "commentlabel" is label for the HTML link, will return an array of tags with first element as tag with comment text "This is an example of inline tags for a documentation comment" and second element as SeeTag with referenced class as "Doc" and the label for the HTML link as "commentlabel".
isInlineTag ( ) : boolean	Return true if this Taglet is an inline tag.
name ( ) : str	Get name of this tag.
setParent ( &$element )	Set this tags parent
tag ( $name, $text, &$root )	Constructor
text ( $doclet ) : str	Get the value of the tag as raw data, without any text processing applied.

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

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