minor #19198 removed dots at the end of @param and @return (fabpot)

This PR was merged into the 2.7 branch.

Discussion
----------

removed dots at the end of @param and @return

| Q             | A
| ------------- | ---
| Branch?       | 2.7
| Bug fix?      | no
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | n/a
| License       | MIT
| Doc PR        | n/a

For phpdocs, we only add dots for sentences like description, but not for @param and @return for instance. This PR fixes this issue.

This should probably be added to PHP-CS-Fixer as well (/cc @phansys @keradus).

Commits
-------

554303e removed dots at the end of @param and @return

Author: fabpot

ContainerAwareEventManager.php

@@ -69,9 +69,9 @@ public function dispatchEvent($eventName, EventArgs $eventArgs = null)
     /**
      * Gets the listeners of a specific event or all listeners.
      *
-     * @param string $event The name of the event.
+     * @param string $event The name of the event
      *
-     * @return array The event listeners for the specified event, or all event listeners.
+     * @return array The event listeners for the specified event, or all event listeners
      */
     public function getListeners($event = null)
     {
@@ -83,7 +83,7 @@ public function getListeners($event = null)
      *
      * @param string $event
      *
-     * @return bool TRUE if the specified event has any listeners, FALSE otherwise.
+     * @return bool TRUE if the specified event has any listeners, FALSE otherwise
      */
     public function hasListeners($event)
     {
@@ -93,8 +93,8 @@ public function hasListeners($event)
     /**
      * Adds an event listener that listens on the specified events.
      *
-     * @param string|array  $events   The event(s) to listen on.
-     * @param object|string $listener The listener object.
+     * @param string|array  $events   The event(s) to listen on
+     * @param object|string $listener The listener object
      *
      * @throws \RuntimeException
      */

DependencyInjection/AbstractDoctrineExtension.php

@@ -40,7 +40,7 @@ abstract class AbstractDoctrineExtension extends Extension
     protected $drivers = array();
 
     /**
-     * @param array            $objectManager A configured object manager.
+     * @param array            $objectManager A configured object manager
      * @param ContainerBuilder $container     A ContainerBuilder instance
      *
      * @throws \InvalidArgumentException
@@ -300,8 +300,8 @@ protected function detectMetadataDriver($dir, ContainerBuilder $container)
     /**
      * Loads a configured object manager metadata, query or result cache driver.
      *
-     * @param array            $objectManager A configured object manager.
-     * @param ContainerBuilder $container     A ContainerBuilder instance.
+     * @param array            $objectManager A configured object manager
+     * @param ContainerBuilder $container     A ContainerBuilder instance
      * @param string           $cacheName
      *
      * @throws \InvalidArgumentException In case of unknown driver type.
@@ -314,10 +314,10 @@ protected function loadObjectManagerCacheDriver(array $objectManager, ContainerB
     /**
      * Loads a cache driver.
      *
-     * @param string                                                  $cacheDriverServiceId The cache driver name.
-     * @param string                                                  $objectManagerName    The object manager name.
-     * @param array                                                   $cacheDriver          The cache driver mapping.
-     * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container            The ContainerBuilder instance.
+     * @param string                                                  $cacheDriverServiceId The cache driver name
+     * @param string                                                  $objectManagerName    The object manager name
+     * @param array                                                   $cacheDriver          The cache driver mapping
+     * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container            The ContainerBuilder instance
      *
      * @return string
      *
@@ -408,7 +408,7 @@ protected function loadCacheDriver($cacheName, $objectManagerName, array $cacheD
      * @param array $managerConfigs
      * @param array $bundles
      *
-     * @return array The modified version of $managerConfigs.
+     * @return array The modified version of $managerConfigs
      */
     protected function fixManagersAutoMappings(array $managerConfigs, array $bundles)
     {

DependencyInjection/CompilerPass/RegisterMappingsPass.php

@@ -106,18 +106,18 @@ abstract class RegisterMappingsPass implements CompilerPassInterface
      * The $aliasMap parameter can be used to define bundle namespace shortcuts like the
      * DoctrineBundle provides automatically for objects in the default Entity/Document folder.
      *
-     * @param Definition|Reference $driver                  Driver DI definition or reference.
-     * @param string[]             $namespaces              List of namespaces handled by $driver.
+     * @param Definition|Reference $driver                  Driver DI definition or reference
+     * @param string[]             $namespaces              List of namespaces handled by $driver
      * @param string[]             $managerParameters       List of container parameters that could
      *                                                      hold the manager name.
-     * @param string               $driverPattern           Pattern for the metadata driver service name.
+     * @param string               $driverPattern           Pattern for the metadata driver service name
      * @param string               $enabledParameter        Service container parameter that must be
      *                                                      present to enable the mapping. Set to false
      *                                                      to not do any check, optional.
-     * @param string               $configurationPattern    Pattern for the Configuration service name.
+     * @param string               $configurationPattern    Pattern for the Configuration service name
      * @param string               $registerAliasMethodName Name of Configuration class method to
      *                                                      register alias.
-     * @param string[]             $aliasMap                Map of alias to namespace.
+     * @param string[]             $aliasMap                Map of alias to namespace
      *
      * @since Support for bundle alias was added in Symfony 2.6
      */
@@ -219,7 +219,7 @@ private function getConfigurationServiceName(ContainerBuilder $container)
      *
      * @param ContainerBuilder $container
      *
-     * @return string The name of the active manager.
+     * @return string The name of the active manager
      *
      * @throws ParameterNotFoundException If none of the managerParameters is found in the container.
      */

Form/ChoiceList/EntityChoiceList.php

@@ -109,7 +109,7 @@ class EntityChoiceList extends ObjectChoiceList
      * @param string                    $groupPath         A property path pointing to the property used
      *                                                     to group the choices. Only allowed if
      *                                                     the choices are given as flat array.
-     * @param PropertyAccessorInterface $propertyAccessor  The reflection graph for reading property paths.
+     * @param PropertyAccessorInterface $propertyAccessor  The reflection graph for reading property paths
      */
     public function __construct(ObjectManager $manager, $class, $labelPath = null, EntityLoaderInterface $entityLoader = null, $entities = null, array $preferredEntities = array(), $groupPath = null, PropertyAccessorInterface $propertyAccessor = null)
     {
@@ -410,7 +410,7 @@ protected function createIndex($entity)
      *
      * @param mixed $entity The choice to create a value for
      *
-     * @return int|string A unique value without character limitations.
+     * @return int|string A unique value without character limitations
      */
     protected function createValue($entity)
     {

Form/ChoiceList/EntityLoaderInterface.php

@@ -21,7 +21,7 @@ interface EntityLoaderInterface
     /**
      * Returns an array of entities that are valid choices in the corresponding choice list.
      *
-     * @return array The entities.
+     * @return array The entities
      */
     public function getEntities();
 
@@ -31,9 +31,9 @@ public function getEntities();
      * @param string $identifier The identifier field of the object. This method
      *                           is not applicable for fields with multiple
      *                           identifiers.
-     * @param array  $values     The values of the identifiers.
+     * @param array  $values     The values of the identifiers
      *
-     * @return array The entities.
+     * @return array The entities
      */
     public function getEntitiesByIds($identifier, array $values);
 }

Form/ChoiceList/IdReader.php

@@ -105,9 +105,9 @@ public function isIntId()
      *
      * This method assumes that the object has a single-column ID.
      *
-     * @param object $object The object.
+     * @param object $object The object
      *
-     * @return mixed The ID value.
+     * @return mixed The ID value
      */
     public function getIdValue($object)
     {
@@ -138,7 +138,7 @@ public function getIdValue($object)
      *
      * This method assumes that the object has a single-column ID.
      *
-     * @return string The name of the ID field.
+     * @return string The name of the ID field
      */
     public function getIdField()
     {

Form/ChoiceList/ORMQueryBuilderLoader.php

@@ -43,8 +43,8 @@ class ORMQueryBuilderLoader implements EntityLoaderInterface
      *                                            deprecated and will not be
      *                                            supported anymore as of
      *                                            Symfony 3.0.
-     * @param ObjectManager         $manager      Deprecated.
-     * @param string                $class        Deprecated.
+     * @param ObjectManager         $manager      Deprecated
+     * @param string                $class        Deprecated
      *
      * @throws UnexpectedTypeException
      */

Form/Type/DoctrineType.php

@@ -56,9 +56,9 @@ abstract class DoctrineType extends AbstractType
      *
      * For backwards compatibility, objects are cast to strings by default.
      *
-     * @param object $choice The object.
+     * @param object $choice The object
      *
-     * @return string The string representation of the object.
+     * @return string The string representation of the object
      *
      * @internal This method is public to be usable as callback. It should not
      *           be used in user code.
@@ -75,12 +75,12 @@ public static function createChoiceLabel($choice)
      * a single-column integer ID. In that case, the value of the field is
      * the ID of the object. That ID is also used as field name.
      *
-     * @param object     $choice The object.
-     * @param int|string $key    The choice key.
+     * @param object     $choice The object
+     * @param int|string $key    The choice key
      * @param string     $value  The choice value. Corresponds to the object's
      *                           ID here.
      *
-     * @return string The field name.
+     * @return string The field name
      *
      * @internal This method is public to be usable as callback. It should not
      *           be used in user code.