Skip to content

Commit 5db17e3

Browse files
authored
fix(DocComment): Allow phpcs ignore comments before a tag (#3523506)
1 parent 92557b9 commit 5db17e3

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

coder_sniffer/Drupal/Sniffs/Commenting/DocCommentSniff.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -370,6 +370,7 @@ public function process(File $phpcsFile, $stackPtr)
370370
if ($tokens[$firstTag]['line'] !== ($tokens[$prev]['line'] + 2)
371371
&& isset($fileShort) === false
372372
&& in_array($tokens[$firstTag]['content'], ['@code', '@link', '@endlink']) === false
373+
&& isset(Tokens::$phpcsCommentTokens[$tokens[$prev]['code']]) === false
373374
) {
374375
$error = 'There must be exactly one blank line before the tags in a doc comment';
375376
$fix = $phpcsFile->addFixableError($error, $firstTag, 'SpacingBeforeTags');

tests/Drupal/good/good.php

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1986,3 +1986,20 @@ protected function getFallbackPluginId($plugin_id, array $configuration = []) {
19861986
}
19871987

19881988
}
1989+
1990+
/**
1991+
* Provides a collection of condition plugins.
1992+
*/
1993+
class ConditionPluginCollection extends DefaultLazyPluginCollection {
1994+
1995+
/**
1996+
* {@inheritdoc}
1997+
*
1998+
* phpcs:ignore Drupal.Commenting.FunctionComment.MissingReturnComment
1999+
* @return \Drupal\Core\Condition\ConditionInterface
2000+
*/
2001+
public function &get($instance_id) {
2002+
return 'x';
2003+
}
2004+
2005+
}

0 commit comments

Comments
 (0)