Add phpdoc for iterators in unit tests

Author: Flyingmana

tests/PHPStan/Type/BenevolentUnionTypeTest.php

@@ -20,6 +20,9 @@
 class BenevolentUnionTypeTest extends PHPStanTestCase
 {
 
+	/**
+	 * @return Iterator<int, array{BenevolentUnionType, TrinaryLogic}>
+	 */
 	public static function dataCanAccessProperties(): Iterator
 	{
 		yield [
@@ -49,6 +52,9 @@ public function testCanAccessProperties(BenevolentUnionType $type, TrinaryLogic
 		);
 	}
 
+	/**
+	 * @return Iterator<int, array{BenevolentUnionType, string, TrinaryLogic}>
+	 */
 	public static function dataHasProperty(): Iterator
 	{
 		yield [
@@ -87,6 +93,9 @@ public function testHasProperty(BenevolentUnionType $type, string $propertyName,
 		);
 	}
 
+	/**
+	 * @return Iterator<int, array{BenevolentUnionType, TrinaryLogic}>
+	 */
 	public static function dataCanCallMethods(): Iterator
 	{
 		yield [
@@ -116,6 +125,9 @@ public function testCanCanCallMethods(BenevolentUnionType $type, TrinaryLogic $e
 		);
 	}
 
+	/**
+	 * @return Iterator<int, array{BenevolentUnionType, string, TrinaryLogic}>
+	 */
 	public static function dataHasMethod(): Iterator
 	{
 		yield [
@@ -151,6 +163,9 @@ public function testHasMethod(BenevolentUnionType $type, string $methodName, Tri
 		);
 	}
 
+	/**
+	 * @return Iterator<int, array{BenevolentUnionType, TrinaryLogic}>
+	 */
 	public static function dataCanAccessConstants(): Iterator
 	{
 		yield [
@@ -180,6 +195,9 @@ public function testCanAccessConstants(BenevolentUnionType $type, TrinaryLogic $
 		);
 	}
 
+	/**
+	 * @return Iterator<int, array{BenevolentUnionType, TrinaryLogic}>
+	 */
 	public static function dataIsIterable(): Iterator
 	{
 		yield [
@@ -215,6 +233,9 @@ public function testIsIterable(BenevolentUnionType $type, TrinaryLogic $expected
 		);
 	}
 
+	/**
+	 * @return Iterator<int, array{BenevolentUnionType, TrinaryLogic}>
+	 */
 	public static function dataIsIterableAtLeastOnce(): Iterator
 	{
 		yield [
@@ -250,6 +271,9 @@ public function testIsIterableAtLeastOnce(BenevolentUnionType $type, TrinaryLogi
 		);
 	}
 
+	/**
+	 * @return Iterator<int, array{BenevolentUnionType, TrinaryLogic}>
+	 */
 	public static function dataIsArray(): Iterator
 	{
 		yield [
@@ -279,6 +303,9 @@ public function testIsArray(BenevolentUnionType $type, TrinaryLogic $expectedRes
 		);
 	}
 
+	/**
+	 * @return Iterator<int, array{BenevolentUnionType, TrinaryLogic}>
+	 */
 	public static function dataIsString(): Iterator
 	{
 		yield [
@@ -311,6 +338,9 @@ public function testIsString(BenevolentUnionType $type, TrinaryLogic $expectedRe
 		);
 	}
 
+	/**
+	 * @return Iterator<int, array{BenevolentUnionType, TrinaryLogic}>
+	 */
 	public static function dataIsNumericString(): Iterator
 	{
 		yield [
@@ -342,6 +372,9 @@ public function testIsNumericString(BenevolentUnionType $type, TrinaryLogic $exp
 		);
 	}
 
+	/**
+	 * @return Iterator<int, array{BenevolentUnionType, TrinaryLogic}>
+	 */
 	public static function dataIsNonFalsyString(): Iterator
 	{
 		yield [
@@ -373,6 +406,9 @@ public function testIsNonFalsyString(BenevolentUnionType $type, TrinaryLogic $ex
 		);
 	}
 
+	/**
+	 * @return Iterator<int, array{BenevolentUnionType, TrinaryLogic}>
+	 */
 	public static function dataIsLiteralString(): Iterator
 	{
 		yield [
@@ -404,6 +440,9 @@ public function testIsLiteralString(BenevolentUnionType $type, TrinaryLogic $exp
 		);
 	}
 
+	/**
+	 * @return Iterator<int, array{BenevolentUnionType, TrinaryLogic}>
+	 */
 	public static function dataIsOffsetAccesible(): Iterator
 	{
 		yield [
@@ -439,6 +478,9 @@ public function testIsOffsetAccessible(BenevolentUnionType $type, TrinaryLogic $
 		);
 	}
 
+	/**
+	 * @return Iterator<int, array{BenevolentUnionType, ConstantStringType, TrinaryLogic}>
+	 */
 	public static function dataHasOffsetValueType(): Iterator
 	{
 		yield [
@@ -477,6 +519,9 @@ public function testHasOffsetValue(BenevolentUnionType $type, Type $offsetType,
 		);
 	}
 
+	/**
+	 * @return Iterator<int, array{BenevolentUnionType, TrinaryLogic}>
+	 */
 	public static function dataIsCallable(): Iterator
 	{
 		yield [
@@ -506,6 +551,9 @@ public function testIsCallable(BenevolentUnionType $type, TrinaryLogic $expected
 		);
 	}
 
+	/**
+	 * @return Iterator<int, array{BenevolentUnionType, TrinaryLogic}>
+	 */
 	public static function dataIsCloneable(): Iterator
 	{
 		yield [

tests/PHPStan/Type/IntersectionTypeTest.php

@@ -28,6 +28,9 @@
 class IntersectionTypeTest extends PHPStanTestCase
 {
 
+	/**
+	 * @return Iterator<int, array{Type, Type, TrinaryLogic}>
+	 */
 	public static function dataAccepts(): Iterator
 	{
 		$intersectionType = new IntersectionType([
@@ -70,7 +73,7 @@ public static function dataAccepts(): Iterator
 	}
 
 	#[DataProvider('dataAccepts')]
-	public function testAccepts(IntersectionType $type, Type $otherType, TrinaryLogic $expectedResult): void
+	public function testAccepts(Type $type, Type $otherType, TrinaryLogic $expectedResult): void
 	{
 		$actualResult = $type->accepts($otherType, true)->result;
 		$this->assertSame(
@@ -121,6 +124,9 @@ public function testIsCallable(IntersectionType $type, TrinaryLogic $expectedRes
 		);
 	}
 
+	/**
+	 * @return Iterator<int, array{IntersectionType, Type, TrinaryLogic}>
+	 */
 	public static function dataIsSuperTypeOf(): Iterator
 	{
 		$intersectionTypeA = new IntersectionType([
@@ -242,6 +248,9 @@ public function testIsSuperTypeOf(IntersectionType $type, Type $otherType, Trina
 		);
 	}
 
+	/**
+	 * @return Iterator<int, array{IntersectionType, Type, TrinaryLogic}>
+	 */
 	public static function dataIsSubTypeOf(): Iterator
 	{
 		$intersectionTypeA = new IntersectionType([

tests/PHPStan/Type/ObjectTypeTest.php

@@ -557,6 +557,9 @@ public function testAccepts(
 		);
 	}
 
+	/**
+	 * @return Iterator<int, array{ObjectType, string, TrinaryLogic}>
+	 */
 	public static function dataHasConstant(): Iterator
 	{
 		yield [

tests/PHPStan/Type/UnionTypeTest.php

@@ -87,6 +87,9 @@ public function testIsCallable(UnionType $type, TrinaryLogic $expectedResult): v
 		);
 	}
 
+	/**
+	 * @return Iterator<int, array{Type}>
+	 */
 	public static function dataSelfCompare(): Iterator
 	{
 		$reflectionProvider = self::createReflectionProvider();
@@ -166,6 +169,9 @@ public function testSelfCompare(Type $type): void
 		);
 	}
 
+	/**
+	 * @return Iterator<array-key, array{UnionType, Type, TrinaryLogic}>
+	 */
 	public static function dataIsSuperTypeOf(): Iterator
 	{
 		$unionTypeA = new UnionType([
@@ -460,6 +466,9 @@ public function testIsSuperTypeOf(UnionType $type, Type $otherType, TrinaryLogic
 		);
 	}
 
+	/**
+	 * @return Iterator<int, array{UnionType, Type, TrinaryLogic}>
+	 */
 	public static function dataIsSubTypeOf(): Iterator
 	{
 		$unionTypeA = new UnionType([