neomerx / json-api

src/Exceptions/JsonApiException.php

Doc Comments +1 added lines, -1 removed lines

@@ -54,7 +54,7 @@
     private $httpCode;
 
     /**
-     * @param ErrorInterface|iterable $errors
+     * @param ErrorInterface $errors
      * @param int                     $httpCode
      * @param Exception|null          $previous
      *

src/Http/Query/BaseQueryParserTrait.php

Doc Comments +8 added lines, -8 removed lines

@@ -30,7 +30,7 @@ 
      * @param array  $parameters
      * @param string $errorTitle
      *
-     * @return iterable
+     * @return \Generator
      */
     protected function getIncludes(array $parameters, string $errorTitle): iterable
     {
@@ -47,7 +47,7 @@ 
      * @param array  $parameters
      * @param string $errorTitle
      *
-     * @return iterable
+     * @return \Generator
      */
     protected function getFields(array $parameters, string $errorTitle): iterable
     {
@@ -67,7 +67,7 @@ 
      * @param array  $parameters
      * @param string $errorTitle
      *
-     * @return iterable
+     * @return \Generator
      */
     protected function getSorts(array $parameters, string $errorTitle): iterable
     {
@@ -99,7 +99,7 @@ 
      * @param array  $parameters
      * @param string $errorTitle
      *
-     * @return iterable
+     * @return \Generator
      */
     protected function getProfileUrls(array $parameters, string $errorTitle): iterable
     {
@@ -119,7 +119,7 @@ 
      * @param string|mixed $shouldBeString
      * @param string       $errorTitle
      *
-     * @return iterable
+     * @return \Generator
      */
     private function splitCommaSeparatedStringAndCheckNoEmpties(
         string $paramName,
@@ -131,10 +131,10 @@ 
 
     /**
      * @param string       $paramName
-     * @param string|mixed $shouldBeString
+     * @param string $shouldBeString
      * @param string       $errorTitle
      *
-     * @return iterable
+     * @return \Generator
      */
     private function splitSpaceSeparatedStringAndCheckNoEmpties(
         string $paramName,
@@ -150,7 +150,7 @@ 
      * @param string       $separator
      * @param string       $errorTitle
      *
-     * @return iterable
+     * @return \Generator
      */
     private function splitStringAndCheckNoEmpties(
         string $paramName,

src/Parser/IdentifierAndResource.php

Doc Comments +1 added lines, -1 removed lines

@@ -448,7 +448,7 @@
      * @param bool     $addSelfLink
      * @param bool     $addRelatedLink
      *
-     * @return iterable
+     * @return \Generator
      */
     private function parseLinks(
         string $relationshipName,

src/Parser/Parser.php

Doc Comments +3 added lines, -3 removed lines

@@ -203,7 +203,7 @@ 
      * @see ResourceInterface
      * @see IdentifierInterface
      *
-     * @return iterable
+     * @return \Generator
      */
     private function parseAsResourcesOrIdentifiers(
         PositionInterface $position,
@@ -225,7 +225,7 @@ 
      *
      * @see ResourceInterface
      *
-     * @return iterable
+     * @return \Generator
      *
      */
     private function parseAsResource(
@@ -246,7 +246,7 @@ 
     /**
      * @param ResourceInterface $resource
      *
-     * @return iterable
+     * @return \Generator
      */
     private function parseResource(ResourceInterface $resource): iterable
     {

src/Encoder/Encoder.php

Doc Comments +1 added lines, -1 removed lines

@@ -819,7 +819,7 @@
      * @param iterable $iterable1
      * @param iterable $iterable2
      *
-     * @return iterable
+     * @return \Generator
      */
     private function mergeIterables(iterable $iterable1, iterable $iterable2): iterable
     {

src/Representation/FieldSetFilter.php

Doc Comments +1 added lines, -1 removed lines

@@ -117,7 +117,7 @@
      * @param string   $type
      * @param iterable $fields
      *
-     * @return iterable
+     * @return \Generator
      */
     protected function filterFields(string $type, iterable $fields): iterable
     {

src/Parser/RelationshipData/BaseRelationshipData.php

Doc Comments +1 added lines, -1 removed lines

@@ -79,7 +79,7 @@
     }
 
     /**
-     * @param mixed $identifier
+     * @param SchemaIdentifierInterface $identifier
      *
      * @return ResourceInterface
      */