PHP Class SmileElasticsuite_Sniffs_Commenting_FunctionCommentSniff, elasticsuite

Author: Aurelien FOUCRET ([email protected])

Inheritance: extends PEAR_Sniffs_Commenting_FunctionCommentSniff

Public Methods

Method	Description
process ( PHP_CodeSniffer_File $phpcsFile, integer $stackPtr ) : void	Processes this test, when one of its tokens is encountered.

Method	Description
isInheritDoc ( PHP_CodeSniffer_File $phpcsFile, integer $stackPtr ) : boolean	Is the comment an inheritdoc?
isMatchingReturn ( array $tokens, integer $returnPos ) : boolean	Is the return statement matching?
processParams ( PHP_CodeSniffer_File $phpcsFile, integer $stackPtr, integer $commentStart ) : void	Process the function parameter comments.
processReturn ( PHP_CodeSniffer_File $phpcsFile, integer $stackPtr, integer $commentStart ) : void	Process the return comment of this function comment.

Is the comment an inheritdoc?

protected isInheritDoc ( PHP_CodeSniffer_File $phpcsFile, integer $stackPtr ) : boolean
$phpcsFile	PHP_CodeSniffer_File	The file being scanned.
$stackPtr	integer	The position of the current token in the stack passed in $tokens.
return	boolean	True if the comment is an inheritdoc

Is the return statement matching?

protected isMatchingReturn ( array $tokens, integer $returnPos ) : boolean
$tokens	array	Array of tokens
$returnPos	integer	Stack position of the T_RETURN token to process
return	boolean	True if the return does not return anything

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

public process ( PHP_CodeSniffer_File $phpcsFile, integer $stackPtr ) : void
$phpcsFile	PHP_CodeSniffer_File	The file being scanned.
$stackPtr	integer	The position of the current token in the stack passed in $tokens.
return	void

Process the function parameter comments.

protected processParams ( PHP_CodeSniffer_File $phpcsFile, integer $stackPtr, integer $commentStart ) : void
$phpcsFile	PHP_CodeSniffer_File	The file being scanned.
$stackPtr	integer	The position of the current token in the stack passed in $tokens.
$commentStart	integer	The position in the stack where the comment started.
return	void

Process the return comment of this function comment.

protected processReturn ( PHP_CodeSniffer_File $phpcsFile, integer $stackPtr, integer $commentStart ) : void
$phpcsFile	PHP_CodeSniffer_File	The file being scanned.
$stackPtr	integer	The position of the current token in the stack passed in $tokens.
$commentStart	integer	The position in the stack where the comment started.
return	void