Docs For Class PEAR_Sniffs_Commenting

Class: PEAR_Sniffs_Commenting_FunctionCommentSniff

Class Overview

Parses and verifies the doc comments for functions.

Author(s):

Marc McIntyre <mmcintyre at squiz.net>
Greg Sherwood <gsherwood at squiz.net>

Version:

Release: 2.7.1

Copyright:

2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)

Methods

Child classes:

Squiz_Sniffs_Commenting_FunctionCommentSniff: Parses and verifies the doc comments for functions.

Inherited Variables

Inherited Methods

Class Details

[line 28]
Parses and verifies the doc comments for functions.

Author: Marc McIntyre <mmcintyre@squiz.net>
Author: Greg Sherwood <gsherwood@squiz.net>
Version: Release: 2.7.1
Copyright: 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
Link: http://pear.php.net/package/PHP_CodeSniffer
License: BSD Licence

Method Detail

process [line 53]

void process(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

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

Access: public

Overridden in child classes as:

MySource_Sniffs_Commenting_FunctionCommentSniff::process(): Processes this test, when one of its tokens is encountered.

Parameters:

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

[ Top ]

processParams [line 209]

void processParams(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr, int
$commentStart)

Process the function parameter comments.

Access: protected

Overridden in child classes as:

Squiz_Sniffs_Commenting_FunctionCommentSniff::processParams(): Process the function parameter comments.

Parameters:

PHP_CodeSniffer_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.

[ Top ]

processReturn [line 120]

void processReturn(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr, int
$commentStart)

Process the return comment of this function comment.

Access: protected

Overridden in child classes as:

Squiz_Sniffs_Commenting_FunctionCommentSniff::processReturn(): Process the return comment of this function comment.

Parameters:

PHP_CodeSniffer_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.

[ Top ]

processThrows [line 169]

void processThrows(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr, int
$commentStart)

Process any throw tags that this function comment has.

Access: protected

Overridden in child classes as:

Squiz_Sniffs_Commenting_FunctionCommentSniff::processThrows(): Process any throw tags that this function comment has.

Parameters:

PHP_CodeSniffer_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.

[ Top ]

register [line 37]

array register(
)

Returns an array of tokens this test wants to listen for.

Access: public

[ Top ]