MediaWiki\Sniffs\Commenting\FunctionCommentSniff Class Reference

Inheritance diagram for MediaWiki\Sniffs\Commenting\FunctionCommentSniff:

Public Member Functions
	register ()
	@inheritDoc
	process (File $phpcsFile, $stackPtr)
	Processes this test, when one of its tokens is encountered.

Protected Member Functions
	processReturn (File $phpcsFile, int $stackPtr, int $commentStart)
	Process the return comment of this function comment.
	processThrows (File $phpcsFile, int $commentStart)
	Process any throw tags that this function comment has.
	processParams (File $phpcsFile, int $stackPtr, int $commentStart)
	Process the function parameter comments.
	replaceParamComment (File $phpcsFile, array $param, array $fixParam)
	param comment

Member Function Documentation

process()

MediaWiki\Sniffs\Commenting\FunctionCommentSniff::process	(	File	$phpcsFile,
			$stackPtr )

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

Parameters

File	$phpcsFile	The file being scanned.
int	$stackPtr	The position of the current token in the stack passed in $tokens.

Returns

void

processParams()

MediaWiki\Sniffs\Commenting\FunctionCommentSniff::processParams ( File $phpcsFile, int $stackPtr, int $commentStart )

protected

Process the function parameter comments.

Parameters

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.

processReturn()

MediaWiki\Sniffs\Commenting\FunctionCommentSniff::processReturn ( File $phpcsFile, int $stackPtr, int $commentStart )

protected

Process the return comment of this function comment.

Parameters

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.

processThrows()

MediaWiki\Sniffs\Commenting\FunctionCommentSniff::processThrows ( File $phpcsFile, int $commentStart )

protected

Process any throw tags that this function comment has.

Parameters

File	$phpcsFile	The file being scanned.
int	$commentStart	The position in the stack where the comment started.

replaceParamComment()

MediaWiki\Sniffs\Commenting\FunctionCommentSniff::replaceParamComment ( File $phpcsFile, array $param, array $fixParam )

protected

param comment

Parameters

File	$phpcsFile	The file being scanned.
array	$param	Array of the

param array $fixParam Array with fixes to

Parameters

.	Only provide keys to replace

---

The documentation for this class was generated from the following file:

• MediaWiki/Sniffs/Commenting/FunctionCommentSniff.php