PHP 클래스 tag

상속: extends CI_Model
파일 보기 프로젝트 열기: peej/phpdoctor 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$_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.

메소드 상세

_getInlineTags() 공개 메소드

Parse out inline tags from within a text string
public _getInlineTags ( $text ) : Tag[]
리턴 Tag[]

displayEmpty() 공개 메소드

Return true if this Taglet should be outputted even if it has no text content.
public displayEmpty ( ) : boolean
리턴 boolean

displayName() 공개 메소드

Get display name of this tag.
public displayName ( ) : str
리턴 str

firstSentenceTags() 공개 메소드

If PEAR compatibility mode is on, the first double line break also ends the first sentence. PEAR documentation advocates ommiting the period from the first sentence.
public firstSentenceTags ( $formatter ) : Tag[]
리턴 Tag[] An array of Tags representing the first sentence of the comment

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

inlineTags() 공개 메소드

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".
public inlineTags ( $formatter ) : Tag[]
리턴 Tag[] Array of tags with inline tags.

isInlineTag() 공개 메소드

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

name() 공개 메소드

Get name of this tag.
public name ( ) : str
리턴 str

setParent() 공개 메소드

Set this tags parent
public setParent ( &$element )

tag() 공개 메소드

Constructor
public tag ( $name, $text, &$root )

text() 공개 메소드

Get the value of the tag as raw data, without any text processing applied.
public text ( $doclet ) : str
리턴 str

프로퍼티 상세

$_name 공개적으로 프로퍼티

The name of the tag.
public str $_name
리턴 str

$_parent 공개적으로 프로퍼티

Reference to the elements parent.
public programElementDoc $_parent
리턴 programElementDoc

$_root 공개적으로 프로퍼티

Reference to the root element.
public rootDoc $_root
리턴 rootDoc

$_text 공개적으로 프로퍼티

The value of the tag as raw data, without any text processing applied.
public str $_text
리턴 str