Skip to content

Commit 7be34ee

Browse files
committed
Corrected documentation for return value (ref ##631)
1 parent 04f2aad commit 7be34ee

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

CodeSniffer/Sniff.php

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,10 @@ public function register();
8383
* file's token stack where the token
8484
* was found.
8585
*
86-
* @return void
86+
* @return void|int Optionally returns a stack pointer. The sniff will not be
87+
* called again on the current file until the returned stack
88+
* pointer is reached. Return (count($tokens) + 1) to skip
89+
* the rest of the file.
8790
*/
8891
public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr);
8992

0 commit comments

Comments
 (0)