Fixed bug #1560 : Squiz.Commenting.FunctionComment fatal error when fixing additional param comment lines that have no indent

Author: gsherwood

package.xml

@@ -51,6 +51,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
     -- Thanks to Michał Bundyra for the patch
   - Fixed bug #1549 : Squiz.PHP.EmbeddedPhp fixer conflict with // comment before PHP close tag
     -- Thanks to Juliette Reinders Folmer for the patch
+  - Fixed bug #1560 : Squiz.Commenting.FunctionComment fatal error when fixing additional param comment lines that have no indent
  </notes>
  <contents>
   <dir name="/">

src/Standards/Squiz/Sniffs/Commenting/FunctionCommentSniff.php

@@ -646,6 +646,10 @@ protected function checkSpacingAfterParamName(File $phpcsFile, $param, $maxVar,
 
                     $diff      = ($param['var_space'] - $spaces);
                     $newIndent = ($param['commentLines'][$lineNum]['indent'] - $diff);
+                    if ($newIndent <= 0) {
+                        continue;
+                    }
+
                     $phpcsFile->fixer->replaceToken(
                         ($param['commentLines'][$lineNum]['token'] - 1),
                         str_repeat(' ', $newIndent)

src/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.inc

@@ -877,3 +877,24 @@ function yieldFromTest()
 {
     yield from foo();
 }
+
+/**
+ * Audio
+ *
+ * Generates an audio element to embed sounds
+ *
+ * @param  mixed  $src                  Either a source string or
+ * an array of sources.
+ * @param  string $unsupportedMessage   The message to display
+ * if the media tag is not supported by the browser.
+ * @param  string $attributes           HTML attributes.
+ * @return string
+ */
+function audio(
+    $src,
+    string $unsupportedMessage = '',
+    string $attributes = '',
+): string
+{
+    return 'test';
+}

src/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.inc.fixed

@@ -877,3 +877,24 @@ function yieldFromTest()
 {
     yield from foo();
 }
+
+/**
+ * Audio
+ *
+ * Generates an audio element to embed sounds
+ *
+ * @param  mixed  $src                Either a source string or
+ * an array of sources.
+ * @param  string $unsupportedMessage The message to display
+ * if the media tag is not supported by the browser.
+ * @param  string $attributes         HTML attributes.
+ * @return string
+ */
+function audio(
+    $src,
+    string $unsupportedMessage = '',
+    string $attributes = '',
+): string
+{
+    return 'test';
+}

src/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.php

@@ -107,6 +107,9 @@ public function getErrorList()
                    840 => 1,
                    852 => 1,
                    864 => 1,
+                   886 => 1,
+                   888 => 1,
+                   890 => 1,
                   );
 
         // The yield tests will only work in PHP versions where yield exists and