PHP Class tag

Inheritance: extends CI_Model
Show file Open project: peej/phpdoctor Class Usage Examples

Public Properties

Property Type Description
$_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.

Public Methods

Method Description
_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.

Method Details

_getInlineTags() public method

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

displayEmpty() public method

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

displayName() public method

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

firstSentenceTags() public method

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[]
return Tag[] An array of Tags representing the first sentence of the comment

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

inlineTags() public method

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[]
return Tag[] Array of tags with inline tags.

isInlineTag() public method

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

name() public method

Get name of this tag.
public name ( ) : str
return str

setParent() public method

Set this tags parent
public setParent ( &$element )

tag() public method

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

text() public method

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

Property Details

$_name public property

The name of the tag.
public str $_name
return str

$_parent public property

Reference to the elements parent.
public programElementDoc $_parent
return programElementDoc

$_root public property

Reference to the root element.
public rootDoc $_root
return rootDoc

$_text public property

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