PHP_CodeSniffer
[ class tree: PHP_CodeSniffer ] [ index: PHP_CodeSniffer ] [ all elements ]

Class: PHP_CodeSniffer_CommentParser_DocElement

Source Location: /PHP_CodeSniffer-0.7.0/CodeSniffer/CommentParser/DocElement.php

Class Overview


A DocElement represents a logical element within a Doc Comment.


Author(s):

Version:

  • Release: 0.7.0

Copyright:

  • 2006 Squiz Pty Ltd (ABN 77 084 670 600)

Methods


Inherited Variables

Inherited Methods


Class Details

[line 29]
A DocElement represents a logical element within a Doc Comment.


[ Top ]


Method Detail

getLine   [line 92]

int getLine( )

Returns the line that this element started on.
  • Access: public

[ Top ]

getNextElement   [line 84]

PHP_CodeSniffer_CommentParser_DocElement getNextElement( )

Returns the element that appears after this element.

[ Top ]

getOrder   [line 66]

int getOrder( )

Returns the order that this element appears in the doc comment.

The first element in the comment should have an order of 1.

  • Access: public

[ Top ]

getPreviousElement   [line 75]

PHP_CodeSniffer_CommentParser_DocElement getPreviousElement( )

Returns the element that appears before this element.

[ Top ]

getRawContent   [line 100]

string getRawContent( )

Returns the raw content of this element, ommiting the tag.
  • Access: public

[ Top ]

getTag   [line 38]

string getTag( )

Returns the name of the tag this element represents, omitting the @ symbol.
  • Access: public

[ Top ]

getWhitespaceAfter   [line 56]

string getWhitespaceAfter( )

Returns the whitespace that exists after this element.

[ Top ]

getWhitespaceBefore   [line 47]

string getWhitespaceBefore( )

Returns the whitespace that exists before this element.

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:06:34 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.