Class: PHP_CodeSniffer_CommentParser_CommentElement

Source Location: /PHP_CodeSniffer-0.1.1/CodeSniffer/CommentParser/CommentElement.php

PHP_CodeSniffer_CommentParser_AbstractDocElement
 |
 --PHP_CodeSniffer_CommentParser_SingleElement
 |
 --PHP_CodeSniffer_CommentParser_CommentElement

A class to represent Comments of a doc comment.

PHP_CodeSniffer_CommentParser_SingleElement::__construct(): Constructs a SingleElement doc tag.
PHP_CodeSniffer_CommentParser_SingleElement::getContent(): Returns the content of this tag.
PHP_CodeSniffer_CommentParser_SingleElement::getSubElements(): Returns the element names that this tag is comprised of, in the order that they appear in the tag.
PHP_CodeSniffer_CommentParser_SingleElement::getWhitespaceBeforeContent(): Returns the witespace before the content of this tag.
PHP_CodeSniffer_CommentParser_SingleElement::processSubElement(): Processes the sub element with the specified name.

PHP_CodeSniffer_CommentParser_AbstractDocElement::__construct(): Constructs a Doc Element.
PHP_CodeSniffer_CommentParser_AbstractDocElement::getLine(): Returns the line in which this element first occured.
PHP_CodeSniffer_CommentParser_AbstractDocElement::getNextElement(): Returns the element that exists after this.
PHP_CodeSniffer_CommentParser_AbstractDocElement::getOrder(): Returns the order that this element appears in the comment.
PHP_CodeSniffer_CommentParser_AbstractDocElement::getPreviousElement(): Returns the element that exists before this.
PHP_CodeSniffer_CommentParser_AbstractDocElement::getRawContent(): Returns the raw content of this element, ommiting the tag.
PHP_CodeSniffer_CommentParser_AbstractDocElement::getSubElements(): Returns the sub element names that make up this element in the order they appear in the element.
PHP_CodeSniffer_CommentParser_AbstractDocElement::getTag(): Returns the tag that this element represents, ommiting the @ symbol.
PHP_CodeSniffer_CommentParser_AbstractDocElement::getWhitespaceAfter(): Returns the whitespace that exists after this element.
PHP_CodeSniffer_CommentParser_AbstractDocElement::getWhitespaceBefore(): Returns the whitespace that exists before this element.
PHP_CodeSniffer_CommentParser_AbstractDocElement::processSubElement(): Called to process each sub element as sepcified in the return value of getSubElements().

[line 56]
A class to represent Comments of a doc comment.

Comments are in the following format.

Note that if there is no period to end the headline, the sentence before two newlines is assumed the headline comment.

[ Top ]

PHP_CodeSniffer_CommentParser_CommentElement __construct(
PHP_CodeSniffer_CommentParser_DocElemement
$previousElement, array
$tokens)

Constructs a PHP_CodeSniffer_CommentParser_CommentElement.

PHP_CodeSniffer_CommentParser_DocElemement $previousElement — The element that appears before this element.

array $tokens — The tokens that make up this element.

[ Top ]

string getBodyComment(
)

Returns the body comment.

[ Top ]

string getHeadlineComment(
)

Returns the headline comment.

[ Top ]

string getWhitespaceAfterHeadline(
)

Returns the whitespace that exists between the headline and the comment.

[ Top ]

boolean isEmpty(
)

Returns true if there is no comment.

[ Top ]