Verifies that block comments are used appropriately.
/**
* Processes this test, when one of its tokens is encountered.
*
* @param PHP_CodeSniffer_File $phpcsFile The current file being scanned.
* @param int $stackPtr The position of the current token in the
* stack passed in $tokens.
*
* @return void
*/
public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
{
$tokens = $phpcsFile->getTokens();
// If it is an inline doc comment for type hinting etc., return.
if (substr($tokens[$stackPtr]['content'], 0, 5) === '/** @') {
return;
}
parent::process($phpcsFile, $stackPtr);
}
/**
* Processes this test, when one of its tokens is encountered.
*
* @param PHP_CodeSniffer_File $phpcsFile The current file being scanned.
* @param int $stackPtr The position of the current token in the stack passed in $tokens.
*
* @return void
*/
public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
{
$commentEnd = $phpcsFile->findNext(T_DOC_COMMENT_CLOSE_TAG, $stackPtr);
$content = $phpcsFile->getTokensAsString($stackPtr, $commentEnd - $stackPtr);
// If it is an inline doc comment for type hinting etc., return.
if (substr($content, 0, 5) === '/** @') {
return;
}
parent::process($phpcsFile, $stackPtr);
}