minor symfony#13066 [2.3] CS And DocBlock Fixes (GrahamCampbell)

This PR was squashed before being merged into the 2.3 branch (closes symfony#13066).

Discussion
----------

[2.3] CS And DocBlock Fixes

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

##### This pull request provides some cs and docblock fixes.

@fabpot The second commit of the two applies the docblock fixes you wanted, using PHP-CS-Fixer/PHP-CS-Fixer#887. I made 3 or 4 minor manual changes because people had put bulleted lists in the "short description" which is not allowed, so we were ending up with colons followed by full stops. I've moved those lists to be part of a "long description".

// cc @keradus

Commits
-------

83c15db [2.3] CS And DocBlock Fixes

Author: fabpot

src/Symfony/Bridge/Doctrine/ContainerAwareEventManager.php

@@ -24,6 +24,7 @@ class ContainerAwareEventManager extends EventManager
 {
     /**
      * Map of registered listeners.
+     *
      * <event> => <listeners>
      *
      * @var array

src/Symfony/Bridge/Doctrine/DependencyInjection/CompilerPass/DoctrineValidationPass.php

@@ -16,7 +16,7 @@
 use Symfony\Component\Config\Resource\FileResource;
 
 /**
- * Registers additional validators
+ * Registers additional validators.
  *
  * @author Benjamin Eberlei <[email protected]>
  */
@@ -43,7 +43,7 @@ public function process(ContainerBuilder $container)
 
     /**
      * Gets the validation mapping files for the format and extends them with
-     * files matching a doctrine search pattern (Resources/config/validation.orm.xml)
+     * files matching a doctrine search pattern (Resources/config/validation.orm.xml).
      *
      * @param ContainerBuilder $container
      * @param string           $mapping

src/Symfony/Bridge/Doctrine/DependencyInjection/CompilerPass/RegisterMappingsPass.php

@@ -35,27 +35,31 @@ abstract class RegisterMappingsPass implements CompilerPassInterface
     /**
      * DI object for the driver to use, either a service definition for a
      * private service or a reference for a public service.
+     *
      * @var Definition|Reference
      */
     protected $driver;
 
     /**
-     * List of namespaces handled by the driver
+     * List of namespaces handled by the driver.
+     *
      * @var string[]
      */
     protected $namespaces;
 
     /**
      * List of potential container parameters that hold the object manager name
      * to register the mappings with the correct metadata driver, for example
-     * array('acme.manager', 'doctrine.default_entity_manager')
+     * array('acme.manager', 'doctrine.default_entity_manager').
+     *
      * @var string[]
      */
     protected $managerParameters;
 
     /**
      * Naming pattern of the metadata chain driver service ids, for example
-     * 'doctrine.orm.%s_metadata_driver'
+     * 'doctrine.orm.%s_metadata_driver'.
+     *
      * @var string
      */
     protected $driverPattern;
@@ -64,6 +68,7 @@ abstract class RegisterMappingsPass implements CompilerPassInterface
      * A name for a parameter in the container. If set, this compiler pass will
      * only do anything if the parameter is present. (But regardless of the
      * value of that parameter.
+     *
      * @var string
      */
     protected $enabledParameter;

src/Symfony/Bridge/Doctrine/Form/ChoiceList/EntityChoiceList.php

@@ -18,7 +18,7 @@
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
 
 /**
- * A choice list presenting a list of Doctrine entities as choices
+ * A choice list presenting a list of Doctrine entities as choices.
  *
  * @author Bernhard Schussek <[email protected]>
  */
@@ -41,7 +41,7 @@ class EntityChoiceList extends ObjectChoiceList
 
     /**
      * Contains the query builder that builds the query for fetching the
-     * entities
+     * entities.
      *
      * This property should only be accessed through queryBuilder.
      *
@@ -50,21 +50,21 @@ class EntityChoiceList extends ObjectChoiceList
     private $entityLoader;
 
     /**
-     * The identifier field, if the identifier is not composite
+     * The identifier field, if the identifier is not composite.
      *
      * @var array
      */
     private $idField = null;
 
     /**
-     * Whether to use the identifier for index generation
+     * Whether to use the identifier for index generation.
      *
      * @var bool
      */
     private $idAsIndex = false;
 
     /**
-     * Whether to use the identifier for value generation
+     * Whether to use the identifier for value generation.
      *
      * @var bool
      */
@@ -98,7 +98,7 @@ class EntityChoiceList extends ObjectChoiceList
      *                                                     the choices are given as flat array.
      * @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)
+    public function __construct(ObjectManager $manager, $class, $labelPath = null, EntityLoaderInterface $entityLoader = null, $entities = null, array $preferredEntities = array(), $groupPath = null, PropertyAccessorInterface $propertyAccessor = null)
     {
         $this->em = $manager;
         $this->entityLoader = $entityLoader;
@@ -128,7 +128,7 @@ public function __construct(ObjectManager $manager, $class, $labelPath = null, E
     }
 
     /**
-     * Returns the list of entities
+     * Returns the list of entities.
      *
      * @return array
      *
@@ -144,7 +144,7 @@ public function getChoices()
     }
 
     /**
-     * Returns the values for the entities
+     * Returns the values for the entities.
      *
      * @return array
      *

src/Symfony/Bridge/Doctrine/Form/ChoiceList/ORMQueryBuilderLoader.php

@@ -17,13 +17,13 @@
 use Doctrine\ORM\EntityManager;
 
 /**
- * Getting Entities through the ORM QueryBuilder
+ * Getting Entities through the ORM QueryBuilder.
  */
 class ORMQueryBuilderLoader implements EntityLoaderInterface
 {
     /**
      * Contains the query builder that builds the query for fetching the
-     * entities
+     * entities.
      *
      * This property should only be accessed through queryBuilder.
      *
@@ -32,7 +32,7 @@ class ORMQueryBuilderLoader implements EntityLoaderInterface
     private $queryBuilder;
 
     /**
-     * Construct an ORM Query Builder Loader
+     * Construct an ORM Query Builder Loader.
      *
      * @param QueryBuilder|\Closure $queryBuilder
      * @param EntityManager         $manager

src/Symfony/Bridge/Doctrine/RegistryInterface.php

@@ -39,7 +39,7 @@ public function getDefaultEntityManagerName();
     public function getEntityManager($name = null);
 
     /**
-     * Gets an array of all registered entity managers
+     * Gets an array of all registered entity managers.
      *
      * @return array An array of EntityManager instances
      */

src/Symfony/Bridge/Doctrine/Security/RememberMe/DoctrineTokenProvider.php

@@ -39,14 +39,14 @@ class DoctrineTokenProvider implements TokenProviderInterface
 {
     /**
      * Doctrine DBAL database connection
-     * F.ex. service id: doctrine.dbal.default_connection
+     * F.ex. service id: doctrine.dbal.default_connection.
      *
      * @var \Doctrine\DBAL\Connection
      */
     private $conn;
 
     /**
-     * new DoctrineTokenProvider for the RemembeMe authentication service
+     * new DoctrineTokenProvider for the RemembeMe authentication service.
      *
      * @param \Doctrine\DBAL\Connection $conn
      */

src/Symfony/Bridge/Doctrine/Tests/DoctrineOrmTestCase.php

@@ -14,7 +14,7 @@
 use Symfony\Bridge\Doctrine\Test\DoctrineTestHelper;
 
 /**
- * Class DoctrineOrmTestCase
+ * Class DoctrineOrmTestCase.
  *
  * @deprecated Deprecated as of Symfony 2.4, to be removed in Symfony 3.0.
  *             Use {@link DoctrineTestHelper} instead.

src/Symfony/Bridge/Doctrine/Tests/Fixtures/AssociationEntity.php

@@ -27,6 +27,7 @@ class AssociationEntity
 
     /**
      * @ORM\ManyToOne(targetEntity="SingleIntIdEntity")
+     *
      * @var \Symfony\Bridge\Doctrine\Tests\Fixtures\SingleIntIdEntity
      */
     public $single;
@@ -37,6 +38,7 @@ class AssociationEntity
      *  @ORM\JoinColumn(name="composite_id1", referencedColumnName="id1"),
      *  @ORM\JoinColumn(name="composite_id2", referencedColumnName="id2")
      * })
+     *
      * @var \Symfony\Bridge\Doctrine\Tests\Fixtures\CompositeIntIdEntity
      */
     public $composite;

src/Symfony/Bridge/Doctrine/Validator/Constraints/UniqueEntity.php

@@ -14,7 +14,7 @@
 use Symfony\Component\Validator\Constraint;
 
 /**
- * Constraint for the Unique Entity validator
+ * Constraint for the Unique Entity validator.
  *
  * @Annotation
  * @Target({"CLASS", "ANNOTATION"})