Fixed bug #3503 : Squiz.Commenting.FunctionComment.ThrowsNoFullStop f…

…alse positive when one line @throw
squizlabs · Dec 20, 2021 · f653fd2 · f653fd2
1 parent c715f09
commit f653fd2
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 0 deletions.
diff --git a/package.xml b/package.xml
@@ -39,6 +39,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
     -- Squiz.Commenting.DocCommentAlignment
     -- Squiz.Commenting.VariableComment
     -- Thanks to Juliette Reinders Folmer for the patches
+  - Fixed bug #3503 : Squiz.Commenting.FunctionComment.ThrowsNoFullStop false positive when one line @throw
  </notes>
  <contents>
   <dir name="/">

diff --git a/src/Standards/Squiz/Sniffs/Commenting/FunctionCommentSniff.php b/src/Standards/Squiz/Sniffs/Commenting/FunctionCommentSniff.php
@@ -245,6 +245,8 @@ protected function processThrows(File $phpcsFile, $stackPtr, $commentStart)
                     }
                 }
 
+                $comment = trim($comment);
+
                 // Starts with a capital letter and ends with a fullstop.
                 $firstChar = $comment[0];
                 if (strtoupper($firstChar) !== $firstChar) {

diff --git a/src/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.inc b/src/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.inc
@@ -1041,3 +1041,8 @@ public function ignored() {
 }
 
 // phpcs:set Squiz.Commenting.FunctionComment specialMethods[] __construct,__destruct
+
+/** 
+ * @return void
+ * @throws Exception If any other error occurs. */
+function throwCommentOneLine() {}
diff --git a/src/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.inc.fixed b/src/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.inc.fixed
@@ -1041,3 +1041,8 @@ public function ignored() {
 }
 
 // phpcs:set Squiz.Commenting.FunctionComment specialMethods[] __construct,__destruct
+
+/** 
+ * @return void
+ * @throws Exception If any other error occurs. */
+function throwCommentOneLine() {}