If __construct has no doc block then return early

jonathan1055 · Nov 10, 2023 · 4261827 · 4261827
1 parent ea46008
commit 4261827
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/coder_sniffer/Drupal/Sniffs/Commenting/FunctionCommentSniff.php b/coder_sniffer/Drupal/Sniffs/Commenting/FunctionCommentSniff.php
@@ -93,6 +93,16 @@ public function process(File $phpcsFile, $stackPtr)
             break;
         }
 
+        // Constructor methods are exempt from requiring a docblock.
+        // @see https://www.drupal.org/project/coder/issues/3400560
+        $methodName = $phpcsFile->getDeclarationName($stackPtr);
+        if ($methodName === '__construct'
+            && $tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG
+            && $tokens[$commentEnd]['code'] !== T_COMMENT
+        ) {
+            return;
+        }
+
         $beforeCommentEnd = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($commentEnd - 1), null, true);
         if (($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG
             && $tokens[$commentEnd]['code'] !== T_COMMENT)