Class: MySource_Sniffs_Commenting_FunctionCommentSniff

Source Location: /PHP_CodeSniffer-2.8.0/CodeSniffer/Standards/MySource/Sniffs/Commenting/FunctionCommentSniff.php

PEAR_Sniffs_Commenting_FunctionCommentSniff
 |
 --Squiz_Sniffs_Commenting_FunctionCommentSniff
 |
 --MySource_Sniffs_Commenting_FunctionCommentSniff

Parses and verifies the doc comments for functions.

Squiz_Sniffs_Commenting_FunctionCommentSniff::checkSpacingAfterParamName(): Check the spacing after the name of a parameter.
Squiz_Sniffs_Commenting_FunctionCommentSniff::checkSpacingAfterParamType(): Check the spacing after the type of a parameter.
Squiz_Sniffs_Commenting_FunctionCommentSniff::processParams(): Process the function parameter comments.
Squiz_Sniffs_Commenting_FunctionCommentSniff::processReturn(): Process the return comment of this function comment.
Squiz_Sniffs_Commenting_FunctionCommentSniff::processThrows(): Process any throw tags that this function comment has.

PEAR_Sniffs_Commenting_FunctionCommentSniff::process(): Processes this test, when one of its tokens is encountered.
PEAR_Sniffs_Commenting_FunctionCommentSniff::processParams(): Process the function parameter comments.
PEAR_Sniffs_Commenting_FunctionCommentSniff::processReturn(): Process the return comment of this function comment.
PEAR_Sniffs_Commenting_FunctionCommentSniff::processThrows(): Process any throw tags that this function comment has.
PEAR_Sniffs_Commenting_FunctionCommentSniff::register(): Returns an array of tokens this test wants to listen for.

[line 34]
Parses and verifies the doc comments for functions.

Same as the Squiz standard, but adds support for API tags.

[ Top ]

void process(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Processes this test, when one of its tokens is encountered.

Overrides PEAR_Sniffs_Commenting_FunctionCommentSniff::process() (Processes this test, when one of its tokens is encountered.)

PHP_CodeSniffer_File $phpcsFile — The file being scanned.

int $stackPtr — The position of the current token in the stack passed in $tokens.

[ Top ]