Skip to content

Commit 7f1c02d

Browse files
authored
Merge pull request #194 from PHPCSStandards/feature/file-findfirstonline-fix-docs
File::findFirstOnLine(): minor correction to the docs
2 parents 4ff4ee0 + 9be358b commit 7f1c02d

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

src/Files/File.php

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2647,15 +2647,18 @@ public function findEndOfStatement($start, $ignore=null)
26472647
*
26482648
* @param int|string|array $types The type(s) of tokens to search for.
26492649
* @param int $start The position to start searching from in the
2650-
* token stack. The first token matching on
2651-
* this line before this token will be returned.
2650+
* token stack.
26522651
* @param bool $exclude If true, find the token that is NOT of
26532652
* the types specified in $types.
26542653
* @param string $value The value that the token must be equal to.
26552654
* If value is omitted, tokens with any value will
26562655
* be returned.
26572656
*
2658-
* @return int|false
2657+
* @return int|false The first token which matches on the line containing the start
2658+
* token, between the start of the line and the start token.
2659+
* Note: The first token matching might be the start token.
2660+
* FALSE when no matching token could be found between the start of
2661+
* the line and the start token.
26592662
*/
26602663
public function findFirstOnLine($types, $start, $exclude=false, $value=null)
26612664
{

0 commit comments

Comments
 (0)