TypeHintDeclarationSniff: Fix UselessDocComment detection when function has parameters/returns, but doesn't have corresponding annotation

Author: Majkl578

SlevomatCodingStandard/Sniffs/TypeHints/TypeHintDeclarationSniff.php

@@ -475,43 +475,50 @@ private function checkUselessDocComment(\PHP_CodeSniffer_File $phpcsFile, int $f
 			return TypeHintHelper::isSimpleTypeHint($typeHint) || TypeHintHelper::getFullyQualifiedTypeHint($phpcsFile, $functionPointer, $typeHint) === TypeHintHelper::getFullyQualifiedTypeHint($phpcsFile, $functionPointer, $typeHintInAnnotation);
 		};
 
-		$returnTypeHint = FunctionHelper::findReturnTypeHint($phpcsFile, $functionPointer);
 		if ($isAbstract || FunctionHelper::returnsValue($phpcsFile, $functionPointer)) {
-			if ($returnTypeHint === null) {
-				return;
-			}
-
-			if ($this->isTraversableTypeHint(TypeHintHelper::getFullyQualifiedTypeHint($phpcsFile, $functionPointer, $returnTypeHint->getTypeHint()))) {
-				return;
-			}
-
+			$returnTypeHint = FunctionHelper::findReturnTypeHint($phpcsFile, $functionPointer);
 			$returnAnnotation = FunctionHelper::findReturnAnnotation($phpcsFile, $functionPointer);
+
 			if ($returnAnnotation !== null) {
-				if (preg_match('~^\\S+\\s+\\S+~', $returnAnnotation->getContent())) {
+				if ($returnTypeHint === null) {
 					return;
 				}
 
-				$returnTypeHintsDefinition = preg_split('~\\s+~', $returnAnnotation->getContent())[0];
-				if ($this->definitionContainsStaticOrThisTypeHint($returnTypeHintsDefinition)) {
+				if ($this->isTraversableTypeHint(TypeHintHelper::getFullyQualifiedTypeHint($phpcsFile, $functionPointer, $returnTypeHint->getTypeHint()))) {
 					return;
-				} elseif ($this->enableNullableTypeHints && $this->definitionContainsJustTwoTypeHints($returnTypeHintsDefinition) && $this->definitionContainsNullTypeHint($returnTypeHintsDefinition)) {
-					$returnTypeHintDefinitionParts = explode('|', $returnTypeHintsDefinition);
-					$returnTypeHintInAnnotation = strtolower($returnTypeHintDefinitionParts[0]) === 'null' ? $returnTypeHintDefinitionParts[1] : $returnTypeHintDefinitionParts[0];
-					if (!$typeHintEqualsAnnotation($returnTypeHint->getTypeHint(), $returnTypeHintInAnnotation)) {
+				}
+
+				if ($returnAnnotation !== null) {
+					if (preg_match('~^\\S+\\s+\\S+~', $returnAnnotation->getContent())) {
+						return;
+					}
+
+					$returnTypeHintsDefinition = preg_split('~\\s+~', $returnAnnotation->getContent())[0];
+					if ($this->definitionContainsStaticOrThisTypeHint($returnTypeHintsDefinition)) {
+						return;
+					} elseif ($this->enableNullableTypeHints && $this->definitionContainsJustTwoTypeHints($returnTypeHintsDefinition) && $this->definitionContainsNullTypeHint($returnTypeHintsDefinition)) {
+						$returnTypeHintDefinitionParts = explode('|', $returnTypeHintsDefinition);
+						$returnTypeHintInAnnotation = strtolower($returnTypeHintDefinitionParts[0]) === 'null' ? $returnTypeHintDefinitionParts[1] : $returnTypeHintDefinitionParts[0];
+						if (!$typeHintEqualsAnnotation($returnTypeHint->getTypeHint(), $returnTypeHintInAnnotation)) {
+							return;
+						}
+					} elseif (!$this->definitionContainsOneTypeHint($returnTypeHintsDefinition)) {
+						return;
+					} elseif (!$typeHintEqualsAnnotation($returnTypeHint->getTypeHint(), $returnTypeHintsDefinition)) {
 						return;
 					}
-				} elseif (!$this->definitionContainsOneTypeHint($returnTypeHintsDefinition)) {
-					return;
-				} elseif (!$typeHintEqualsAnnotation($returnTypeHint->getTypeHint(), $returnTypeHintsDefinition)) {
-					return;
 				}
 			}
 		}
 
 		$parametersTypeHintsDefinitions = $this->getFunctionParameterTypeHintsDefinitions($phpcsFile, $functionPointer);
 		foreach (FunctionHelper::getParametersTypeHints($phpcsFile, $functionPointer) as $parameterName => $parameterTypeHint) {
 			if ($parameterTypeHint === null) {
-				return;
+				if (array_key_exists($parameterName, $parametersTypeHintsDefinitions)) {
+					return;
+				} else {
+					continue;
+				}
 			}
 
 			if ($this->isTraversableTypeHint(TypeHintHelper::getFullyQualifiedTypeHint($phpcsFile, $functionPointer, $parameterTypeHint->getTypeHint()))) {

tests/Sniffs/TypeHints/TypeHintDeclarationSniffTest.php

@@ -34,7 +34,7 @@ public function testErrors()
 			],
 		]);
 
-		$this->assertSame(51, $report->getErrorCount());
+		$this->assertSame(53, $report->getErrorCount());
 
 		$this->assertSniffError($report, 8, TypeHintDeclarationSniff::CODE_MISSING_PARAMETER_TYPE_HINT);
 		$this->assertSniffError($report, 15, TypeHintDeclarationSniff::CODE_MISSING_PARAMETER_TYPE_HINT);
@@ -56,6 +56,8 @@ public function testErrors()
 		$this->assertSniffError($report, 87, TypeHintDeclarationSniff::CODE_MISSING_RETURN_TYPE_HINT);
 		$this->assertSniffError($report, 111, TypeHintDeclarationSniff::CODE_MISSING_RETURN_TYPE_HINT);
 
+		$this->assertSniffError($report, 15, TypeHintDeclarationSniff::CODE_USELESS_DOC_COMMENT);
+		$this->assertSniffError($report, 55, TypeHintDeclarationSniff::CODE_USELESS_DOC_COMMENT);
 		$this->assertSniffError($report, 95, TypeHintDeclarationSniff::CODE_USELESS_DOC_COMMENT);
 		$this->assertSniffError($report, 102, TypeHintDeclarationSniff::CODE_USELESS_DOC_COMMENT);
 		$this->assertSniffError($report, 214, TypeHintDeclarationSniff::CODE_USELESS_DOC_COMMENT);