Squiz_Sniffs_Commenting_BlockCommentSniff
in package
implements
PHP_CodeSniffer_Sniff
Squiz_Sniffs_Commenting_BlockCommentSniff.
Verifies that block comments are used appropriately.
Tags
Interfaces, Classes and Traits
- PHP_CodeSniffer_Sniff
- Represents a PHP_CodeSniffer sniff for sniffing coding standards.
Table of Contents
- $_tabWidth : int
- The --tab-width CLI value that is being used.
- 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.
Properties
$_tabWidth
The --tab-width CLI value that is being used.
private
int
$_tabWidth
=
ull
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 current 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>