The helper returns a Boolean, not void.

squizlabs · Aug 13, 2020 · b598112 · b598112
1 parent 826f7e8
commit b598112
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/src/Standards/Squiz/Sniffs/Commenting/FunctionCommentSniff.php b/src/Standards/Squiz/Sniffs/Commenting/FunctionCommentSniff.php
@@ -728,7 +728,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 void
+     * @return boolean TRUE if the docblock contains only {@inheritdoc} (case-insensitive).
      */
     protected function checkInheritdoc(File $phpcsFile, $stackPtr, $commentStart)
     {