🐛 Fix the way comment before return is handled

Author: VincentLanglet

SymfonyCustom/Sniffs/Formatting/BlankLineBeforeReturnSniff.php

@@ -37,12 +37,14 @@ public function process(File $phpcsFile, $stackPtr)
         $tokens = $phpcsFile->getTokens();
         $current = $stackPtr;
         $previousLine = $tokens[$stackPtr]['line'] - 1;
-        $prevLineTokens  = array();
+        $prevLineTokens = array();
 
         while ($current >= 0 && $tokens[$current]['line'] >= $previousLine) {
             if ($tokens[$current]['line'] === $previousLine
                 && 'T_WHITESPACE' !== $tokens[$current]['type']
                 && 'T_COMMENT' !== $tokens[$current]['type']
+                && 'T_DOC_COMMENT_STRING' !== $tokens[$current]['type']
+                && 'T_DOC_COMMENT_OPEN_TAG' !== $tokens[$current]['type']
                 && 'T_DOC_COMMENT_CLOSE_TAG' !== $tokens[$current]['type']
                 && 'T_DOC_COMMENT_WHITESPACE' !== $tokens[$current]['type']
             ) {
@@ -62,7 +64,7 @@ public function process(File $phpcsFile, $stackPtr)
             $fix = $phpcsFile->addFixableError(
                 'Missing blank line before return statement',
                 $stackPtr,
-                'MissedBlankLineBeforeRetrun'
+                'MissedBlankLineBeforeReturn'
             );
 
             if (true === $fix) {

SymfonyCustom/Tests/Formatting/BlankLineBeforeReturnUnitTest.inc

@@ -31,6 +31,12 @@ function validFunctionReturnFive()
     return;
 }
 
+function validFunctionReturnSix()
+{
+    /** comment */
+    return;
+}
+
 function invalidFunctionReturnOne()
 {
     echo "";

SymfonyCustom/Tests/Formatting/BlankLineBeforeReturnUnitTest.inc.fixed

@@ -31,6 +31,12 @@ function validFunctionReturnFive()
     return;
 }
 
+function validFunctionReturnSix()
+{
+    /** comment */
+    return;
+}
+
 function invalidFunctionReturnOne()
 {
     echo "";

SymfonyCustom/Tests/Formatting/BlankLineBeforeReturnUnitTest.php

@@ -22,7 +22,7 @@ class BlankLineBeforeReturnUnitTest extends AbstractSniffUnitTest
     public function getErrorList()
     {
         return array(
-            37 => 1,
+            43 => 1,
         );
     }