Skip to content

Commit 443307e

Browse files
Docblock fixes
1 parent 6945a2a commit 443307e

File tree

356 files changed

+1546
-1467
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

356 files changed

+1546
-1467
lines changed

src/Symfony/Bridge/Doctrine/ContainerAwareEventManager.php

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,11 @@ public function __construct(ContainerInterface $container)
4040
/**
4141
* Dispatches an event to all registered listeners.
4242
*
43-
* @param string $eventName The name of the event to dispatch. The name of the event is
44-
* the name of the method that is invoked on listeners.
43+
* @param string $eventName The name of the event to dispatch. The name of the event is
44+
* the name of the method that is invoked on listeners.
4545
* @param EventArgs $eventArgs The event arguments to pass to the event handlers/listeners.
4646
* If not supplied, the single empty EventArgs instance is used.
47+
*
4748
* @return bool
4849
*/
4950
public function dispatchEvent($eventName, EventArgs $eventArgs = null)
@@ -81,7 +82,7 @@ public function getListeners($event = null)
8182
*
8283
* @param string $event
8384
*
84-
* @return bool TRUE if the specified event has any listeners, FALSE otherwise.
85+
* @return bool TRUE if the specified event has any listeners, FALSE otherwise.
8586
*/
8687
public function hasListeners($event)
8788
{

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ class RegisterEventListenersAndSubscribersPass implements CompilerPassInterface
3535
* @param string $connections Parameter ID for connections
3636
* @param string $managerTemplate sprintf() template for generating the event
3737
* manager's service ID for a connection name
38-
* @param string $tagPrefix Tag prefix for listeners and subscribers
38+
* @param string $tagPrefix Tag prefix for listeners and subscribers
3939
*/
4040
public function __construct($connections, $managerTemplate, $tagPrefix)
4141
{

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ public function process(ContainerBuilder $container)
118118
* @return string a service definition name
119119
*
120120
* @throws ParameterNotFoundException if non of the managerParameters has a
121-
* non-empty value.
121+
* non-empty value.
122122
*/
123123
protected function getChainDriverServiceName(ContainerBuilder $container)
124124
{
@@ -138,7 +138,7 @@ protected function getChainDriverServiceName(ContainerBuilder $container)
138138
* Create the service definition for the metadata driver.
139139
*
140140
* @param ContainerBuilder $container passed on in case an extending class
141-
* needs access to the container.
141+
* needs access to the container.
142142
*
143143
* @return Definition|Reference the metadata driver to add to all chain drivers
144144
*/
@@ -156,7 +156,7 @@ protected function getDriver(ContainerBuilder $container)
156156
*
157157
* @param ContainerBuilder $container
158158
*
159-
* @return bool whether this compiler pass really should register the mappings
159+
* @return bool whether this compiler pass really should register the mappings
160160
*/
161161
protected function enabled(ContainerBuilder $container)
162162
{

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -365,8 +365,8 @@ public function getIndicesForValues(array $values)
365365
*
366366
* @param mixed $entity The choice to create an index for
367367
*
368-
* @return int|string A unique index containing only ASCII letters,
369-
* digits and underscores.
368+
* @return int|string A unique index containing only ASCII letters,
369+
* digits and underscores.
370370
*/
371371
protected function createIndex($entity)
372372
{
@@ -386,7 +386,7 @@ protected function createIndex($entity)
386386
*
387387
* @param mixed $entity The choice to create a value for
388388
*
389-
* @return int|string A unique value without character limitations.
389+
* @return int|string A unique value without character limitations.
390390
*/
391391
protected function createValue($entity)
392392
{
@@ -444,7 +444,7 @@ private function load()
444444
*
445445
* @param object $entity The entity for which to get the identifier
446446
*
447-
* @return array The identifier values
447+
* @return array The identifier values
448448
*
449449
* @throws RuntimeException If the entity does not exist in Doctrine's identity map
450450
*/

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public function getEntities();
3131
* @param string $identifier The identifier field of the object. This method
3232
* is not applicable for fields with multiple
3333
* identifiers.
34-
* @param array $values The values of the identifiers.
34+
* @param array $values The values of the identifiers.
3535
*
3636
* @return array The entities.
3737
*/

src/Symfony/Bridge/Doctrine/Form/DataTransformer/CollectionToArrayTransformer.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ public function transform($collection)
5454
*
5555
* @param mixed $array An array of entities
5656
*
57-
* @return Collection A collection of entities
57+
* @return Collection A collection of entities
5858
*/
5959
public function reverseTransform($array)
6060
{

src/Symfony/Bridge/Doctrine/Form/Type/EntityType.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ class EntityType extends DoctrineType
2222
* @param ObjectManager $manager
2323
* @param mixed $queryBuilder
2424
* @param string $class
25+
*
2526
* @return ORMQueryBuilderLoader
2627
*/
2728
public function getLoader(ObjectManager $manager, $queryBuilder, $class)

src/Symfony/Bridge/Monolog/Tests/Processor/WebProcessorTest.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ public function testUsesRequestServerData()
6060
}
6161

6262
/**
63-
* @param int $level
64-
* @param string $message
63+
* @param int $level
64+
* @param string $message
6565
*
6666
* @return array Record
6767
*/

src/Symfony/Bridge/Propel1/Form/ChoiceList/ModelChoiceList.php

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -70,12 +70,12 @@ class ModelChoiceList extends ObjectChoiceList
7070
*
7171
* @see \Symfony\Bridge\Propel1\Form\Type\ModelType How to use the preferred choices.
7272
*
73-
* @param string $class The FQCN of the model class to be loaded.
74-
* @param string $labelPath A property path pointing to the property used for the choice labels.
75-
* @param array $choices An optional array to use, rather than fetching the models.
76-
* @param ModelCriteria $queryObject The query to use retrieving model data from database.
77-
* @param string $groupPath A property path pointing to the property used to group the choices.
78-
* @param array|ModelCriteria $preferred The preferred items of this choice.
73+
* @param string $class The FQCN of the model class to be loaded.
74+
* @param string $labelPath A property path pointing to the property used for the choice labels.
75+
* @param array $choices An optional array to use, rather than fetching the models.
76+
* @param ModelCriteria $queryObject The query to use retrieving model data from database.
77+
* @param string $groupPath A property path pointing to the property used to group the choices.
78+
* @param array|ModelCriteria $preferred The preferred items of this choice.
7979
* Either an array if $choices is given,
8080
* or a ModelCriteria to be merged with the $queryObject.
8181
* @param PropertyAccessorInterface $propertyAccessor The reflection graph for reading property paths.
@@ -358,8 +358,8 @@ public function getIndicesForValues(array $values)
358358
*
359359
* @param mixed $model The choice to create an index for
360360
*
361-
* @return int|string A unique index containing only ASCII letters,
362-
* digits and underscores.
361+
* @return int|string A unique index containing only ASCII letters,
362+
* digits and underscores.
363363
*/
364364
protected function createIndex($model)
365365
{
@@ -379,7 +379,7 @@ protected function createIndex($model)
379379
*
380380
* @param mixed $model The choice to create a value for
381381
*
382-
* @return int|string A unique value without character limitations.
382+
* @return int|string A unique value without character limitations.
383383
*/
384384
protected function createValue($model)
385385
{

src/Symfony/Bridge/Propel1/Security/User/PropelUserProvider.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ class PropelUserProvider implements UserProviderInterface
4747
/**
4848
* Default constructor
4949
*
50-
* @param string $class The User model class.
51-
* @param string|null $property The property to use to retrieve a user.
50+
* @param string $class The User model class.
51+
* @param string|null $property The property to use to retrieve a user.
5252
*/
5353
public function __construct($class, $property = null)
5454
{

0 commit comments

Comments
 (0)