Adjust error and code for unexpected & prefix

squizlabs · Jun 8, 2023 · 605d788 · 605d788
1 parent 5f8c04d
commit 605d788
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/Standards/Squiz/Sniffs/Commenting/FunctionCommentSniff.php b/src/Standards/Squiz/Sniffs/Commenting/FunctionCommentSniff.php
@@ -585,6 +585,11 @@ protected function processParams(File $phpcsFile, $stackPtr, $commentStart)
 
                     $error .= 'actual variable name %s';
 
+                    if ($code === 'ParamNameNoMatch' && $paramVarName === '&'.$realName) {
+                        $error = 'Doc comment for parameter %s has leading &, but %s is not passed by reference';
+                        $code  = 'ParamNameUnexpectedAmpersandPrefix';
+                    }
+
                     $phpcsFile->addError($error, $param['tag'], $code, $data);
                 }//end if
             } else if (substr($param['var'], -4) !== ',...') {