PEAR_Sniffs_Commenting_FunctionCommentSniff
in package
implements
PHP_CodeSniffer_Sniff
Parses and verifies the doc comments for functions.
Tags
Interfaces, Classes and Traits
- PHP_CodeSniffer_Sniff
- Represents a PHP_CodeSniffer sniff for sniffing coding standards.
Table of Contents
- process() : void
- Processes this test, when one of its tokens is encountered.
- register() : array<string|int, mixed>
- Returns an array of tokens this test wants to listen for.
- processParams() : void
- Process the function parameter comments.
- processReturn() : void
- Process the return comment of this function comment.
- processThrows() : void
- Process any throw tags that this function comment has.
Methods
process()
Processes this test, when one of its tokens is encountered.
public
process(PHP_CodeSniffer_File $phpcsFile, int $stackPtr) : void
Parameters
- $phpcsFile : PHP_CodeSniffer_File
-
The file being scanned.
- $stackPtr : int
-
The position of the current token in the stack passed in $tokens.
Return values
void —register()
Returns an array of tokens this test wants to listen for.
public
register() : array<string|int, mixed>
Return values
array<string|int, mixed> —processParams()
Process the function parameter comments.
protected
processParams(PHP_CodeSniffer_File $phpcsFile, int $stackPtr, int $commentStart) : void
Parameters
- $phpcsFile : PHP_CodeSniffer_File
-
The file being scanned.
- $stackPtr : int
-
The position of the current token in the stack passed in $tokens.
- $commentStart : int
-
The position in the stack where the comment started.
Return values
void —processReturn()
Process the return comment of this function comment.
protected
processReturn(PHP_CodeSniffer_File $phpcsFile, int $stackPtr, int $commentStart) : void
Parameters
- $phpcsFile : PHP_CodeSniffer_File
-
The file being scanned.
- $stackPtr : int
-
The position of the current token in the stack passed in $tokens.
- $commentStart : int
-
The position in the stack where the comment started.
Return values
void —processThrows()
Process any throw tags that this function comment has.
protected
processThrows(PHP_CodeSniffer_File $phpcsFile, int $stackPtr, int $commentStart) : void
Parameters
- $phpcsFile : PHP_CodeSniffer_File
-
The file being scanned.
- $stackPtr : int
-
The position of the current token in the stack passed in $tokens.
- $commentStart : int
-
The position in the stack where the comment started.