Update PHPDoc for data providers

emodric · emodric · commit 2b09e0fb5f49 · 2025-12-29T20:59:09.000+01:00
diff --git a/phpstan.tests.neon b/phpstan.tests.neon
@@ -3,8 +3,3 @@ parameters:
 
     paths:
         - tests
-
-    ignoreErrors:
-        # Disable errors about missing value types in PHPUnit data providers
-
-        - '#Method .+Test::\w+DataProvider\(\) return type has no value type specified in iterable type iterable.#'
diff --git a/tests/lib/Parameters/ParameterType/ChannelTypeTest.php b/tests/lib/Parameters/ParameterType/ChannelTypeTest.php
@@ -61,6 +61,9 @@ public function testInvalidOptions(array $options): void
         $this->getParameterDefinition($options);
     }
 
+    /**
+     * @return iterable<mixed>
+     */
     public static function validOptionsDataProvider(): iterable
     {
         return [
@@ -89,6 +92,9 @@ public static function validOptionsDataProvider(): iterable
         ];
     }
 
+    /**
+     * @return iterable<mixed>
+     */
     public static function invalidOptionsDataProvider(): iterable
     {
         return [
@@ -151,6 +157,9 @@ public function testIsValueEmpty(mixed $value, bool $isEmpty): void
         self::assertSame($isEmpty, $this->type->isValueEmpty(new ParameterDefinition(), $value));
     }
 
+    /**
+     * @return iterable<mixed>
+     */
     public static function emptyDataProvider(): iterable
     {
         return [
diff --git a/tests/lib/Parameters/ParameterType/ComponentTypeTest.php b/tests/lib/Parameters/ParameterType/ComponentTypeTest.php
@@ -53,6 +53,9 @@ public function testInvalidOptions(array $options): void
         $this->getParameterDefinition($options);
     }
 
+    /**
+     * @return iterable<mixed>
+     */
     public static function validOptionsDataProvider(): iterable
     {
         return [
@@ -75,6 +78,9 @@ public static function validOptionsDataProvider(): iterable
         ];
     }
 
+    /**
+     * @return iterable<mixed>
+     */
     public static function invalidOptionsDataProvider(): iterable
     {
         return [
@@ -92,6 +98,9 @@ public function testIsValueEmpty(mixed $value, bool $isEmpty): void
         self::assertSame($isEmpty, $this->type->isValueEmpty(new ParameterDefinition(), $value));
     }
 
+    /**
+     * @return iterable<mixed>
+     */
     public static function emptyDataProvider(): iterable
     {
         return [
diff --git a/tests/lib/Parameters/ParameterType/ProductTypeTest.php b/tests/lib/Parameters/ParameterType/ProductTypeTest.php
@@ -68,6 +68,9 @@ public function testInvalidOptions(array $options): void
         $this->getParameterDefinition($options);
     }
 
+    /**
+     * @return iterable<mixed>
+     */
     public static function validOptionsDataProvider(): iterable
     {
         return [
@@ -78,6 +81,9 @@ public static function validOptionsDataProvider(): iterable
         ];
     }
 
+    /**
+     * @return iterable<mixed>
+     */
     public static function invalidOptionsDataProvider(): iterable
     {
         return [
@@ -135,6 +141,9 @@ public function testIsValueEmpty(mixed $value, bool $isEmpty): void
         self::assertSame($isEmpty, $this->type->isValueEmpty(new ParameterDefinition(), $value));
     }
 
+    /**
+     * @return iterable<mixed>
+     */
     public static function emptyDataProvider(): iterable
     {
         return [
diff --git a/tests/lib/Parameters/ParameterType/TaxonTypeTest.php b/tests/lib/Parameters/ParameterType/TaxonTypeTest.php
@@ -68,6 +68,9 @@ public function testInvalidOptions(array $options): void
         $this->getParameterDefinition($options);
     }
 
+    /**
+     * @return iterable<mixed>
+     */
     public static function validOptionsDataProvider(): iterable
     {
         return [
@@ -78,6 +81,9 @@ public static function validOptionsDataProvider(): iterable
         ];
     }
 
+    /**
+     * @return iterable<mixed>
+     */
     public static function invalidOptionsDataProvider(): iterable
     {
         return [
@@ -135,6 +141,9 @@ public function testIsValueEmpty(mixed $value, bool $isEmpty): void
         self::assertSame($isEmpty, $this->type->isValueEmpty(new ParameterDefinition(), $value));
     }
 
+    /**
+     * @return iterable<mixed>
+     */
     public static function emptyDataProvider(): iterable
     {
         return [

Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,9 @@ public function testInvalidOptions(array $options): void`
`61`	`61`	`$this->getParameterDefinition($options);`
`62`	`62`	`}`
`63`	`63`
	`64`	`+ /**`
	`65`	`+ * @return iterable<mixed>`
	`66`	`+ */`
`64`	`67`	`public static function validOptionsDataProvider(): iterable`
`65`	`68`	`{`
`66`	`69`	`return [`
`@@ -89,6 +92,9 @@ public static function validOptionsDataProvider(): iterable`
`89`	`92`	`];`
`90`	`93`	`}`
`91`	`94`
	`95`	`+ /**`
	`96`	`+ * @return iterable<mixed>`
	`97`	`+ */`
`92`	`98`	`public static function invalidOptionsDataProvider(): iterable`
`93`	`99`	`{`
`94`	`100`	`return [`
`@@ -151,6 +157,9 @@ public function testIsValueEmpty(mixed $value, bool $isEmpty): void`
`151`	`157`	`self::assertSame($isEmpty, $this->type->isValueEmpty(new ParameterDefinition(), $value));`
`152`	`158`	`}`
`153`	`159`
	`160`	`+ /**`
	`161`	`+ * @return iterable<mixed>`
	`162`	`+ */`
`154`	`163`	`public static function emptyDataProvider(): iterable`
`155`	`164`	`{`
`156`	`165`	`return [`
Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,9 @@ public function testInvalidOptions(array $options): void`
`53`	`53`	`$this->getParameterDefinition($options);`
`54`	`54`	`}`
`55`	`55`
	`56`	`+ /**`
	`57`	`+ * @return iterable<mixed>`
	`58`	`+ */`
`56`	`59`	`public static function validOptionsDataProvider(): iterable`
`57`	`60`	`{`
`58`	`61`	`return [`
`@@ -75,6 +78,9 @@ public static function validOptionsDataProvider(): iterable`
`75`	`78`	`];`
`76`	`79`	`}`
`77`	`80`
	`81`	`+ /**`
	`82`	`+ * @return iterable<mixed>`
	`83`	`+ */`
`78`	`84`	`public static function invalidOptionsDataProvider(): iterable`
`79`	`85`	`{`
`80`	`86`	`return [`
`@@ -92,6 +98,9 @@ public function testIsValueEmpty(mixed $value, bool $isEmpty): void`
`92`	`98`	`self::assertSame($isEmpty, $this->type->isValueEmpty(new ParameterDefinition(), $value));`
`93`	`99`	`}`
`94`	`100`
	`101`	`+ /**`
	`102`	`+ * @return iterable<mixed>`
	`103`	`+ */`
`95`	`104`	`public static function emptyDataProvider(): iterable`
`96`	`105`	`{`
`97`	`106`	`return [`
Original file line number	Diff line number	Diff line change
`@@ -68,6 +68,9 @@ public function testInvalidOptions(array $options): void`
`68`	`68`	`$this->getParameterDefinition($options);`
`69`	`69`	`}`
`70`	`70`
	`71`	`+ /**`
	`72`	`+ * @return iterable<mixed>`
	`73`	`+ */`
`71`	`74`	`public static function validOptionsDataProvider(): iterable`
`72`	`75`	`{`
`73`	`76`	`return [`
`@@ -78,6 +81,9 @@ public static function validOptionsDataProvider(): iterable`
`78`	`81`	`];`
`79`	`82`	`}`
`80`	`83`
	`84`	`+ /**`
	`85`	`+ * @return iterable<mixed>`
	`86`	`+ */`
`81`	`87`	`public static function invalidOptionsDataProvider(): iterable`
`82`	`88`	`{`
`83`	`89`	`return [`
`@@ -135,6 +141,9 @@ public function testIsValueEmpty(mixed $value, bool $isEmpty): void`
`135`	`141`	`self::assertSame($isEmpty, $this->type->isValueEmpty(new ParameterDefinition(), $value));`
`136`	`142`	`}`
`137`	`143`
	`144`	`+ /**`
	`145`	`+ * @return iterable<mixed>`
	`146`	`+ */`
`138`	`147`	`public static function emptyDataProvider(): iterable`
`139`	`148`	`{`
`140`	`149`	`return [`