Makes "Squiz.Commenting.FunctionComment" sniff understand description in "@return" tag

Author: Alexander Obuhovich

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

@@ -97,9 +97,12 @@ protected function processReturn(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $co
                     }
                 }
 
+                // Ignores description, that might come after return type.
+                list($returnType,) = explode(' ', $content, 2);
+
                 // If the return type is void, make sure there is
                 // no return statement in the function.
-                if ($content === 'void') {
+                if ($returnType === 'void') {
                     if (isset($tokens[$stackPtr]['scope_closer']) === true) {
                         $endToken = $tokens[$stackPtr]['scope_closer'];
                         for ($returnToken = $stackPtr; $returnToken < $endToken; $returnToken++) {
@@ -125,7 +128,7 @@ protected function processReturn(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $co
                             }
                         }
                     }//end if
-                } else if ($content !== 'mixed') {
+                } else if ($returnType !== 'mixed') {
                     // If return type is not void, there needs to be a return statement
                     // somewhere in the function that returns something.
                     if (isset($tokens[$stackPtr]['scope_closer']) === true) {

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

@@ -751,3 +751,37 @@ public function myFunction(string $name1, string ...$name2) {
  */
 public function myFunction(string $name1, string ...$name2) {
 }
+
+/**
+ * Return description function + correct type.
+ *
+ * @return integer This is a description.
+ */
+public function myFunction() {
+    return 5;
+}
+
+/**
+ * Return description function + incorrect type.
+ *
+ * @return int This is a description.
+ */
+public function myFunction() {
+    return 5;
+}
+
+/**
+ * Return description function + no return.
+ *
+ * @return void This is a description.
+ */
+public function myFunction() {
+}
+
+/**
+ * Return description function + mixed return.
+ *
+ * @return mixed This is a description.
+ */
+public function myFunction() {
+}