Cleanup more @return annotations

Author: nicolas-grekas

DependencyInjection/AbstractDoctrineExtension.php

@@ -259,7 +259,7 @@ protected function assertValidMappingConfiguration(array $mappingConfig, string
     /**
      * Detects what metadata driver to use for the supplied directory.
      *
-     * @return string|null A metadata driver short name, if one can be detected
+     * @return string|null
      */
     protected function detectMetadataDriver(string $dir, ContainerBuilder $container)
     {
@@ -379,7 +379,7 @@ protected function loadCacheDriver(string $cacheName, string $objectManagerName,
      *
      * The manager called $autoMappedManager will map all bundles that are not mapped by other managers.
      *
-     * @return array The modified version of $managerConfigs
+     * @return array
      */
     protected function fixManagersAutoMappings(array $managerConfigs, array $bundles)
     {

DependencyInjection/CompilerPass/RegisterMappingsPass.php

@@ -165,7 +165,7 @@ public function process(ContainerBuilder $container)
      * Get the service name of the metadata chain driver that the mappings
      * should be registered with.
      *
-     * @return string The name of the chain driver service
+     * @return string
      *
      * @throws InvalidArgumentException if non of the managerParameters has a
      *                                  non-empty value
@@ -181,7 +181,7 @@ protected function getChainDriverServiceName(ContainerBuilder $container)
      * @param ContainerBuilder $container Passed on in case an extending class
      *                                    needs access to the container
      *
-     * @return Definition|Reference the metadata driver to add to all chain drivers
+     * @return Definition|Reference
      */
     protected function getDriver(ContainerBuilder $container)
     {
@@ -228,7 +228,7 @@ private function getManagerName(ContainerBuilder $container): string
      * This default implementation checks if the class has the enabledParameter
      * configured and if so if that parameter is present in the container.
      *
-     * @return bool whether this compiler pass really should register the mappings
+     * @return bool
      */
     protected function enabled(ContainerBuilder $container)
     {

Form/ChoiceList/EntityLoaderInterface.php

@@ -21,14 +21,14 @@ interface EntityLoaderInterface
     /**
      * Returns an array of entities that are valid choices in the corresponding choice list.
      *
-     * @return array The entities
+     * @return array
      */
     public function getEntities();
 
     /**
      * Returns an array of entities matching the given identifiers.
      *
-     * @return array The entities
+     * @return array
      */
     public function getEntitiesByIds(string $identifier, array $values);
 }

Form/ChoiceList/IdReader.php

@@ -59,9 +59,6 @@ public function __construct(ObjectManager $om, ClassMetadata $classMetadata)
 
     /**
      * Returns whether the class has a single-column ID.
-     *
-     * @return bool returns `true` if the class has a single-column ID and
-     *              `false` otherwise
      */
     public function isSingleId(): bool
     {
@@ -70,9 +67,6 @@ public function isSingleId(): bool
 
     /**
      * Returns whether the class has a single-column integer ID.
-     *
-     * @return bool returns `true` if the class has a single-column integer ID
-     *              and `false` otherwise
      */
     public function isIntId(): bool
     {
@@ -84,7 +78,7 @@ public function isIntId(): bool
      *
      * This method assumes that the object has a single-column ID.
      *
-     * @return string The ID value
+     * @return string
      */
     public function getIdValue(object $object = null)
     {
@@ -111,8 +105,6 @@ public function getIdValue(object $object = null)
      * Returns the name of the ID field.
      *
      * This method assumes that the object has a single-column ID.
-     *
-     * @return string The name of the ID field
      */
     public function getIdField(): string
     {

Form/DataTransformer/CollectionToArrayTransformer.php

@@ -24,7 +24,7 @@ class CollectionToArrayTransformer implements DataTransformerInterface
     /**
      * Transforms a collection into an array.
      *
-     * @return mixed An array of entities
+     * @return mixed
      *
      * @throws TransformationFailedException
      */
@@ -52,7 +52,7 @@ public function transform($collection)
      *
      * @param mixed $array An array of entities
      *
-     * @return Collection A collection of entities
+     * @return Collection
      */
     public function reverseTransform($array)
     {

Form/Type/DoctrineType.php

@@ -86,9 +86,6 @@ public static function createChoiceName(object $choice, $key, string $value): st
      * @param object $queryBuilder A query builder, type declaration is not present here as there
      *                             is no common base class for the different implementations
      *
-     * @return array|null Array with important QueryBuilder parts or null if
-     *                    they can't be determined
-     *
      * @internal This method is public to be usable as callback. It should not
      *           be used in user code.
      */