Class: FunctionCommentSniff
Source Location: /PHP_CodeSniffer-3.0.0a1/src/Standards/PEAR/Sniffs/Commenting/FunctionCommentSniff.php
Parses and verifies the doc comments for functions.
Author(s):
Copyright:
- 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
Inherited Variables
Inherited Methods
Class Details
[line
16]
Parses and verifies the doc comments for functions.
Method Detail
process [line 41]
void process(
File
$phpcsFile, int
$stackPtr)
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.
processParams [line 197]
void processParams(
File
$phpcsFile, int
$stackPtr, int
$commentStart)
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.
processReturn [line 108]
void processReturn(
File
$phpcsFile, int
$stackPtr, int
$commentStart)
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.
processThrows [line 157]
void processThrows(
File
$phpcsFile, int
$stackPtr, int
$commentStart)
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.
register [line 25]
Returns an array of tokens this test wants to listen for.
Documentation generated on 2019年3月11日 14:53:28 -0400 by
phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.