Class: Squiz_Sniffs_Commenting_FunctionCommentSniff

Source Location: /PHP_CodeSniffer-2.5.0/CodeSniffer/Standards/Squiz/Sniffs/Commenting/FunctionCommentSniff.php

PEAR_Sniffs_Commenting_FunctionCommentSniff
 |
 --Squiz_Sniffs_Commenting_FunctionCommentSniff

Parses and verifies the doc comments for functions.

MySource_Sniffs_Commenting_FunctionCommentSniff: Parses and verifies the doc comments for functions.

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 32]
Parses and verifies the doc comments for functions.

[ Top ]

void processParams(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr, int
$commentStart)

Process the function parameter comments.

PHP_CodeSniffer_File $phpcsFile — The file being scanned.

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

int $commentStart — The position in the stack where the comment started.

[ Top ]

void processReturn(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr, int
$commentStart)

Process the return comment of this function comment.

Overrides PEAR_Sniffs_Commenting_FunctionCommentSniff::processReturn() (Process the return comment of this function comment.)

PHP_CodeSniffer_File $phpcsFile — The file being scanned.

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

int $commentStart — The position in the stack where the comment started.

[ Top ]

void processThrows(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr, int
$commentStart)

Process any throw tags that this function comment has.

Overrides PEAR_Sniffs_Commenting_FunctionCommentSniff::processThrows() (Process any throw tags that this function comment has.)

PHP_CodeSniffer_File $phpcsFile — The file being scanned.

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

int $commentStart — The position in the stack where the comment started.

[ Top ]