Skip to content

Generic/DocComment: bug fix - don't remove ignore annotations when fixing #3893

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Generic/DocComment: bug fix - don't remove ignore annotations when fixing #3893

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions src/Standards/Generic/Sniffs/Commenting/DocCommentSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Util\Tokens;

class DocCommentSniff implements Sniff
{
Expand Down Expand Up @@ -280,9 +281,12 @@ public function process(File $phpcsFile, $stackPtr)
}

// Check that there was single blank line after the tag block
// but account for a multi-line tag comments.
// but account for multi-line tag comments.
$find = Tokens::$phpcsCommentTokens;
$find[T_DOC_COMMENT_TAG] = T_DOC_COMMENT_TAG;

$lastTag = $group[$pos];
$next = $phpcsFile->findNext(T_DOC_COMMENT_TAG, ($lastTag + 3), $commentEnd);
$next = $phpcsFile->findNext($find, ($lastTag + 3), $commentEnd);
if ($next !== false) {
$prev = $phpcsFile->findPrevious([T_DOC_COMMENT_TAG, T_DOC_COMMENT_STRING], ($next - 1), $commentStart);
if ($tokens[$next]['line'] !== ($tokens[$prev]['line'] + 2)) {
Expand Down
10 changes: 10 additions & 0 deletions src/Standards/Generic/Tests/Commenting/DocCommentUnitTest.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,4 +249,14 @@
* @link http://pear.php.net/package/PHP_CodeSniffer
*/

/**
* Do something.
*
* @codeCoverageIgnore
*
* @phpcs:disable Stnd.Cat.SniffName
*
* @return void
*/

/** No docblock close tag. Must be last test without new line.
10 changes: 10 additions & 0 deletions src/Standards/Generic/Tests/Commenting/DocCommentUnitTest.inc.fixed
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,4 +254,14 @@
* @link http://pear.php.net/package/PHP_CodeSniffer
*/

/**
* Do something.
*
* @codeCoverageIgnore
*
* @phpcs:disable Stnd.Cat.SniffName
*
* @return void
*/

/** No docblock close tag. Must be last test without new line.