Remove superfluous PHPDoc tags (#2111)

* Remove superfluous PHPDoc tags

* Remove one more faulty param tag

* alpha order

* Fix PHPStan

Author: dunglas

.php_cs.dist

@@ -63,6 +63,7 @@ return PhpCsFixer\Config::create()
                 'use',
             ],
         ],
+        'no_superfluous_phpdoc_tags' => true,
         'no_useless_else' => true,
         'no_useless_return' => true,
         'ordered_imports' => [

phpstan.neon

@@ -34,4 +34,3 @@ parameters:
         - '#Method ApiPlatform\\Core\\Bridge\\Doctrine\\Orm\\Filter\\FilterInterface::apply\(\) invoked with 5 parameters, 3-4 required\.#'
         - '#Method ApiPlatform\\Core\\Bridge\\Doctrine\\Orm\\Filter\\OrderFilter::filterProperty\(\) invoked with 7 parameters, 5-6 required\.#'
         - '#Method ApiPlatform\\Core\\DataProvider\\CollectionDataProviderInterface::getCollection\(\) invoked with 3 parameters, 1-2 required.#'
-        - '#PHPDoc tag @param references unknown parameter \$operationName#'

src/Action/ExceptionAction.php

@@ -46,9 +46,8 @@ final class ExceptionAction
     private $exceptionToStatus;
 
     /**
-     * @param SerializerInterface $serializer
-     * @param array               $errorFormats      A list of enabled formats, the first one will be the default
-     * @param array               $exceptionToStatus A list of exceptions mapped to their HTTP status code
+     * @param array $errorFormats      A list of enabled formats, the first one will be the default
+     * @param array $exceptionToStatus A list of exceptions mapped to their HTTP status code
      */
     public function __construct(SerializerInterface $serializer, array $errorFormats, array $exceptionToStatus = [])
     {
@@ -59,11 +58,6 @@ public function __construct(SerializerInterface $serializer, array $errorFormats
 
     /**
      * Converts a an exception to a JSON response.
-     *
-     * @param FlattenException $exception
-     * @param Request          $request
-     *
-     * @return Response
      */
     public function __invoke(FlattenException $exception, Request $request): Response
     {

src/Api/FilterCollectionFactory.php

@@ -36,10 +36,6 @@ public function __construct(array $filtersIds)
 
     /**
      * Creates a filter collection from a filter locator.
-     *
-     * @param ContainerInterface $filterLocator
-     *
-     * @return FilterCollection
      */
     public function createFilterCollectionFromLocator(ContainerInterface $filterLocator): FilterCollection
     {

src/Api/FilterInterface.php

@@ -37,10 +37,6 @@ interface FilterInterface
      * The description can contain additional data specific to a filter.
      *
      * @see \ApiPlatform\Core\Swagger\Serializer\DocumentationNormalizer::getFiltersParameters
-     *
-     * @param string $resourceClass
-     *
-     * @return array
      */
     public function getDescription(string $resourceClass): array;
 }

src/Api/FilterLocatorTrait.php

@@ -31,7 +31,6 @@ trait FilterLocatorTrait
      * Sets a filter locator with a backward compatibility.
      *
      * @param ContainerInterface|FilterCollection|null $filterLocator
-     * @param bool                                     $allowNull
      */
     private function setFilterLocator($filterLocator = null, bool $allowNull = false)
     {
@@ -49,7 +48,6 @@ private function setFilterLocator($filterLocator = null, bool $allowNull = false
     /**
      * Gets a filter with a backward compatibility.
      *
-     * @param string $filterId
      *
      * @return FilterInterface|null
      */

src/Api/IdentifiersExtractorInterface.php

@@ -33,8 +33,6 @@ public function getIdentifiersFromResourceClass(string $resourceClass): array;
      * @param object $item
      *
      * @throws RuntimeException
-     *
-     * @return array
      */
     public function getIdentifiersFromItem($item): array;
 }

src/Api/IriConverterInterface.php

@@ -27,8 +27,6 @@ interface IriConverterInterface
     /**
      * Retrieves an item from its IRI.
      *
-     * @param string $iri
-     * @param array  $context
      *
      * @throws InvalidArgumentException
      * @throws ItemNotFoundException
@@ -41,50 +39,33 @@ public function getItemFromIri(string $iri, array $context = []);
      * Gets the IRI associated with the given item.
      *
      * @param object $item
-     * @param int    $referenceType
      *
      * @throws InvalidArgumentException
      * @throws RuntimeException
-     *
-     * @return string
      */
     public function getIriFromItem($item, int $referenceType = UrlGeneratorInterface::ABS_PATH): string;
 
     /**
      * Gets the IRI associated with the given resource collection.
      *
-     * @param string $resourceClass
-     * @param int    $referenceType
      *
      * @throws InvalidArgumentException
-     *
-     * @return string
      */
     public function getIriFromResourceClass(string $resourceClass, int $referenceType = UrlGeneratorInterface::ABS_PATH): string;
 
     /**
      * Gets the item IRI associated with the given resource.
      *
-     * @param string $resourceClass
-     * @param array  $identifiers
-     * @param int    $referenceType
      *
      * @throws InvalidArgumentException
-     *
-     * @return string
      */
     public function getItemIriFromResourceClass(string $resourceClass, array $identifiers, int $referenceType = UrlGeneratorInterface::ABS_PATH): string;
 
     /**
      * Gets the IRI associated with the given resource subresource.
      *
-     * @param string $resourceClass
-     * @param array  $identifiers
-     * @param int    $referenceType
      *
      * @throws InvalidArgumentException
-     *
-     * @return string
      */
     public function getSubresourceIriFromResourceClass(string $resourceClass, array $identifiers, int $referenceType = UrlGeneratorInterface::ABS_PATH): string;
 }

src/Api/OperationMethodResolverInterface.php

@@ -25,24 +25,16 @@ interface OperationMethodResolverInterface
     /**
      * Resolves the uppercased HTTP method associated with a collection operation.
      *
-     * @param string $resourceClass
-     * @param string $operationName
      *
      * @throws RuntimeException
-     *
-     * @return string
      */
     public function getCollectionOperationMethod(string $resourceClass, string $operationName): string;
 
     /**
      * Resolves the uppercased HTTP method associated with an item operation.
      *
-     * @param string $resourceClass
-     * @param string $operationName
      *
      * @throws RuntimeException
-     *
-     * @return string
      */
     public function getItemOperationMethod(string $resourceClass, string $operationName): string;
 }

src/Api/OperationTypeDeprecationHelper.php

@@ -30,8 +30,6 @@ final class OperationTypeDeprecationHelper
 {
     /**
      * @param string|bool $operationType
-     *
-     * @return string
      */
     public static function getOperationType($operationType): string
     {