Commit c881f78d authored by Mitch Portier's avatar Mitch Portier Committed by Klaus Purer
Browse files

fix(FunctionComment): Recognise 'yield from' as valid return statement (#3106904 by Arkener)

parent bfd339cd

coder_sniffer/Drupal/Sniffs/Commenting/FunctionCommentSniff.php

+1 −1
Original line number Diff line number Diff line
@@ -279,7 +279,7 @@ class FunctionCommentSniff implements Sniff 
                            $searchStart        = $stackPtr;

                            $foundNonVoidReturn = false;

                            do {

                                $returnToken = $phpcsFile->findNext([T_RETURN, T_YIELD], $searchStart, $endToken);

                                $returnToken = $phpcsFile->findNext([T_RETURN, T_YIELD, T_YIELD_FROM], $searchStart, $endToken);

                                if ($returnToken === false && $foundReturnToken === false) {

                                    $error = '@return doc comment specified, but function has no return statement';

                                    $phpcsFile->addError($error, $return, 'InvalidNoReturn');

coder_sniffer/Drupal/Test/Commenting/FunctionCommentUnitTest.inc

+10 −0
Original line number Diff line number Diff line
@@ -506,3 +506,13 @@ class Small { 
function test37(array $matches, array $sub_key, $to) {



}



/**

 * Yield from should be a recognised return statement.

 *

 * @return Generator

 *   Generator value.

 */

function test38($a, $b) {

  yield from [$a, $b];

}

coder_sniffer/Drupal/Test/Commenting/FunctionCommentUnitTest.inc.fixed

+10 −0
Original line number Diff line number Diff line
@@ -532,3 +532,13 @@ class Small { 
function test37(array $matches, array $sub_key, $to) {



}



/**

 * Yield from should be a recognised return statement.

 *

 * @return Generator

 *   Generator value.

 */

function test38($a, $b) {

  yield from [$a, $b];

}