fix: skip processing of Squiz.Commenting.FunctionComment for @inheritdoc

It's supported to use {@inheritdoc}. Add a support of @inheritdoc (w/ brackets). Original PR number - squizlabs#3051 Closes squizlabs#2770
PavelSavushkinMix · Jan 17, 2022 · 39d7001 · 39d7001
1 parent 498a939
commit 39d7001
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/src/Standards/Squiz/Sniffs/Commenting/FunctionCommentSniff.php b/src/Standards/Squiz/Sniffs/Commenting/FunctionCommentSniff.php
@@ -737,7 +737,7 @@ protected function checkSpacingAfterParamName(File $phpcsFile, $param, $maxVar,
      *                                                  in the stack passed in $tokens.
      * @param int                         $commentStart The position in the stack where the comment started.
      *
-     * @return boolean TRUE if the docblock contains only {@inheritdoc} (case-insensitive).
+     * @return boolean TRUE if the docblock contains {@inheritdoc} or @inheritdoc (case-insensitive).
      */
     protected function checkInheritdoc(File $phpcsFile, $stackPtr, $commentStart)
     {
@@ -751,12 +751,12 @@ protected function checkInheritdoc(File $phpcsFile, $stackPtr, $commentStart)
         for ($i = $commentStart; $i <= $tokens[$commentStart]['comment_closer']; $i++) {
             if (in_array($tokens[$i]['code'], $allowedTokens) === false) {
                 $trimmedContent = strtolower(trim($tokens[$i]['content']));
+	            $allowedInheritDocs = [
+		            '{@inheritdoc}',
+		            '@inheritdoc',
+	            ];
 
-                if ($trimmedContent === '{@inheritdoc}') {
-                    return true;
-                } else {
-                    return false;
-                }
+	            return in_array($trimmedContent, $allowedInheritDocs);
             }
         }