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

Packages:
PHP_CodeSniffer

Classes:

Files:

AbstractDocElement.php
AbstractParser.php
AbstractPatternSniff.php
AbstractScopeSniff.php
AbstractVariableSniff.php
ClassCommentParser.php
CodeSniffer.php
CommentElement.php
ControlSignatureSniff.php
DocElement.php
Exception.php
File.php
FunctionCallSignatureSniff.php
FunctionCommentParser.php
IncludingFileSniff.php
IncorrectPatternException.php
InlineCommentSniff.php
LineLengthSniff.php
LowerCaseConstantSniff.php
MemberCommentParser.php
MethodCallArgumentSpacingSniff.php
MultipleStatementSniff.php
OpeningMethodBraceSniff.php
PairElement.php
ParameterElement.php
ParserException.php
ScopeClosingBraceSniff.php
ScopeIndentSniff.php
ShortOpenTagSniff.php
SingleElement.php
Sniff.php
SniffException.php
Tokens.php
ValidClassNameSniff.php
ValidConstantNameSniff.php
ValidDefaultValueSniff.php
ValidFunctionNameSniff.php

Class: PHP_CodeSniffer_CommentParser_FunctionCommentParser

Source Location: /PHP_CodeSniffer-0.1.0/CodeSniffer/CommentParser/FunctionCommentParser.php

Class Overview

PHP_CodeSniffer_CommentParser_AbstractParser
 |
 --PHP_CodeSniffer_CommentParser_FunctionCommentParser

Parses function doc comments.

Author(s):

Squiz Pty Ltd

Methods

Inherited Variables

Class: PHP_CodeSniffer_CommentParser_AbstractParser

PHP_CodeSniffer_CommentParser_AbstractParser::$comment
PHP_CodeSniffer_CommentParser_AbstractParser::$deprecated
PHP_CodeSniffer_CommentParser_AbstractParser::$links
PHP_CodeSniffer_CommentParser_AbstractParser::$previousElement
PHP_CodeSniffer_CommentParser_AbstractParser::$sees
PHP_CodeSniffer_CommentParser_AbstractParser::$since
PHP_CodeSniffer_CommentParser_AbstractParser::$words

Inherited Methods

Class: PHP_CodeSniffer_CommentParser_AbstractParser

PHP_CodeSniffer_CommentParser_AbstractParser::__construct(): Constructs a Doc Comment Parser.
PHP_CodeSniffer_CommentParser_AbstractParser::getAllowedTags(): Returns a list of tags that this comment parser allows for it's comment.
PHP_CodeSniffer_CommentParser_AbstractParser::getComment(): Returns the comment element that appears at the top of this doc comment.
PHP_CodeSniffer_CommentParser_AbstractParser::getDeprecated(): Returns the deprecated element found in this comment.
PHP_CodeSniffer_CommentParser_AbstractParser::getLine(): Returns the line that the token exists on in the doc comment.
PHP_CodeSniffer_CommentParser_AbstractParser::getLinks(): Returns the link elements found in this comment.
PHP_CodeSniffer_CommentParser_AbstractParser::getSees(): Returns the see elements that appear in this doc comment.
PHP_CodeSniffer_CommentParser_AbstractParser::getSince(): Returns the since element found in this comment.
PHP_CodeSniffer_CommentParser_AbstractParser::parse(): Initiates the parsing of the doc comment.
PHP_CodeSniffer_CommentParser_AbstractParser::parseComment(): Parses the comment element that appears at the top of the doc comment.
PHP_CodeSniffer_CommentParser_AbstractParser::parseDeprecated(): Parses \@deprecated tags.
PHP_CodeSniffer_CommentParser_AbstractParser::parseLink(): Parses \@link tags.
PHP_CodeSniffer_CommentParser_AbstractParser::parseSee(): Parses see tag element within the doc comment.
PHP_CodeSniffer_CommentParser_AbstractParser::parseSince(): Parses \@since tags.
PHP_CodeSniffer_CommentParser_AbstractParser::parseTag(): Parses the specified tag.

Class Details

[line 45]
Parses function doc comments.

Author: Squiz Pty Ltd

[ Top ]

Method Detail

__construct (Constructor) [line 76]

PHP_CodeSniffer_CommentParser_FunctionCommentParser __construct(
string
$comment)

Constructs a PHP_CodeSniffer_CommentParser_FunctionCommentParser.

Access: public

Overrides PHP_CodeSniffer_CommentParser_AbstractParser::__construct() (Constructs a Doc Comment Parser.)

Parameters:

string $comment — The comment to parse.

[ Top ]

getAllowedTags [line 182]

array(string getAllowedTags(
)

Returns the allowed tags that can exist in a function comment.

Return: => boolean)
Access: protected

Overrides PHP_CodeSniffer_CommentParser_AbstractParser::getAllowedTags() (Returns a list of tags that this comment parser allows for it's comment.)

[ Top ]

getParams [line 142]

array(PHP_CodeSniffer_CommentParser_ParameterElement) getParams(
)

Returns the parameter elements that this function comment contains.

Returns an empty array if no parameter elements are contained within this function comment.

Access: public

[ Top ]

getReturn [line 156]

PHP_CodeSniffer_CommentParser_PairElement getReturn(
)

Returns the return element in this fucntion comment.

Returns null if no return element exists in the comment.

Access: public

[ Top ]

getThrows [line 170]

array(PHP_CodeSniffer_CommentParser_PairElement) getThrows(
)

Returns the throws elements in this fucntion comment.

Returns empty array if no throws elements in the comment.

Access: public

[ Top ]

parseParam [line 90]

PHP_CodeSniffer_CommentParser_ParameterElement parseParam(
array(string)
$tokens)

Parses parameter elements.

Access: protected

Parameters:

array(string) $tokens — The tokens that conmpise this sub element.

[ Top ]

parseReturn [line 107]

PHP_CodeSniffer_CommentParser_PairElement parseReturn(
array(string)
$tokens)

Parses return elements.

Access: protected

Parameters:

array(string) $tokens — The tokens that conmpise this sub element.

[ Top ]

parseThrows [line 124]

PHP_CodeSniffer_CommentParser_PairElement parseThrows(
array(string)
$tokens)

Parses throws elements.

Access: protected

Parameters:

array(string) $tokens — The tokens that conmpise this sub element.

[ Top ]