8000 minor #19198 removed dots at the end of @param and @return (fabpot) · symfony/symfony@b111d37 · GitHub
[go: up one dir, main page]
Skip to content

Commit b111d37

Browse files
fabpotfabpot
committed
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
2 parents a980774 + 554303e commit b111d37

File tree

227 files changed

+967
-967
lines changed

Some content is hidden

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

227 files changed

+967
-967
lines changed

‎src/Symfony/Bridge/Doctrine/ContainerAwareEventManager.php‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,9 @@ public function dispatchEvent($eventName, EventArgs $eventArgs = null)
6969
/**
7070
* Gets the listeners of a specific event or all listeners.
7171
*
72-
* @param string $event The name of the event.
72+
* @param string $event The name of the event
7373
*
74-
* @return array The event listeners for the specified event, or all event listeners.
74+
* @return array The event listeners for the specified event, or all event listeners
7575
*/
7676
public function getListeners($event = null)
7777
{
@@ -83,7 +83,7 @@ public function getListeners($event = null)
8383
*
8484
* @param string $event
8585
*
86-
* @return bool TRUE if the specified event has any listeners, FALSE otherwise.
86+
* @return bool TRUE if the specified event has any listeners, FALSE otherwise
8787
*/
8888
public function hasListeners($event)
8989
{
@@ -93,8 +93,8 @@ public function hasListeners($event)
9393
/**
9494
* Adds an event listener that listens on the specified events.
9595
*
96-
* @param string|array $events The event(s) to listen on.
97-
* @param object|string $listener The listener object.
96+
* @param string|array $events The event(s) to listen on
97+
* @param object|string $listener The listener object
9898
*
9999
* @throws \RuntimeException
100100
*/

‎src/Symfony/Bridge/Doctrine/DependencyInjection/AbstractDoctrineExtension.php‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ abstract class AbstractDoctrineExtension extends Extension
4040
protected $drivers = array();
4141

4242
/**
43-
* @param array $objectManager A configured object manager.
43+
* @param array $objectManager A configured object manager
4444
* @param ContainerBuilder $container A ContainerBuilder instance
4545
*
4646
* @throws \InvalidArgumentException
@@ -300,8 +300,8 @@ protected function detectMetadataDriver($dir, ContainerBuilder $container)
300300
/**
301301
* Loads a configured object manager metadata, query or result cache driver.
302302
*
303-
* @param array $objectManager A configured object manager.
304-
* @param ContainerBuilder $container A ContainerBuilder instance.
303+
* @param array $objectManager A configured object manager
304+
* @param ContainerBuilder $container A ContainerBuilder instance
305305
* @param string $cacheName
306306
*
307307
* @throws \InvalidArgumentException In case of unknown driver type.
@@ -314,10 +314,10 @@ protected function loadObjectManagerCacheDriver(array $objectManager, ContainerB
314314
/**
315315
* Loads a cache driver.
316316
*
317-
* @param string $cacheDriverServiceId The cache driver name.
318-
* @param string $objectManagerName The object manager name.
319-
* @param array $cacheDriver The cache driver mapping.
320-
* @param \Symfony\Component\DependencyInjection\ContainerBuilder $container The ContainerBuilder instance.
317+
* @param string $cacheDriverServiceId The cache driver name
318+
* @param string $objectManagerName The object manager name
319+
* @param array $cacheDriver The cache driver mapping
320+
* @param \Symfony\Component\DependencyInjection\ContainerBuilder $container The ContainerBuilder instance
321321
*
322322
* @return string
323323
*
@@ -408,7 +408,7 @@ protected function loadCacheDriver($cacheName, $objectManagerName, array $cacheD
408408
* @param array $managerConfigs
409409
* @param array $bundles
410410
*
411-
* @return array The modified version of $managerConfigs.
411+
* @return array The modified version of $managerConfigs
412412
*/
413413
protected function fixManagersAutoMappings(array $managerConfigs, array $bundles)
414414
{

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -106,18 +106,18 @@ abstract class RegisterMappingsPass implements CompilerPassInterface
106106
* The $aliasMap parameter can be used to define bundle namespace shortcuts like the
107107
* DoctrineBundle provides automatically for objects in the default Entity/Document folder.
108108
*
109-
* @param Definition|Reference $driver Driver DI definition or reference.
110-
* @param string[] $namespaces List of namespaces handled by $driver.
109+
* @param Definition|Reference $driver Driver DI definition or reference
110+
* @param string[] $namespaces List of namespaces handled by $driver
111111
* @param string[] $managerParameters List of container parameters that could
112112
* hold the manager name.
113-
* @param string $driverPattern Pattern for the metadata driver service name.
113+
* @param string $driverPattern Pattern for the metadata driver service name
114114
* @param string $enabledParameter Service container parameter that must be
115115
* present to enable the mapping. Set to false
116116
* to not do any check, optional.
117-
* @param string $configurationPattern Pattern for the Configuration service name.
117+
* @param string $configurationPattern Pattern for the Configuration service name
118118
* @param string $registerAliasMethodName Name of Configuration class method to
119119
* register alias.
120-
* @param string[] $aliasMap Map of alias to namespace.
120+
* @param string[] $aliasMap Map of alias to namespace
121121
*
122122
* @since Support for bundle alias was added in Symfony 2.6
123123
*/
@@ -219,7 +219,7 @@ private function getConfigurationServiceName(ContainerBuilder $container)
219219
*
220220
* @param ContainerBuilder $container
221221
*
222-
* @return string The name of the active manager.
222+
* @return string The name of the active manager
223223
*
224224
* @throws ParameterNotFoundException If none of the managerParameters is found in the container.
225225
*/

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ class EntityChoiceList extends ObjectChoiceList
109109
* @param string $groupPath A property path pointing to the property used
110110
* to group the choices. Only allowed if
111111
* the choices are given as flat array.
112-
* @param PropertyAccessorInterface $propertyAccessor The reflection graph for reading property paths.
112+
* @param PropertyAccessorInterface $propertyAccessor The reflection graph for reading property paths
113113
*/
114114
public function __construct(ObjectManager $manager, $class, $labelPath = null, EntityLoaderInterface $entityLoader = null, $entities = null, array $preferredEntities = array(), $groupPath = null, PropertyAccessorInterface $propertyAccessor = null)
115115
{
@@ -410,7 +410,7 @@ protected function createIndex($entity)
410410
*
411411
* @param mixed $entity The choice to create a value for
412412
*
413-
* @return int|string A unique value without character limitations.
413+
* @return int|string A unique value without character limitations
414414
*/
415415
protected function createValue($entity)
416416
{

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ interface EntityLoaderInterface
2121
/**
2222
* Returns an array of entities that are valid choices in the corresponding choice list.
2323
*
24-
* @return array The entities.
24+
* @return array The entities
2525
*/
2626
public function getEntities();
2727

@@ -31,9 +31,9 @@ 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
*
36-
* @return array The entities.
36+
* @return array The entities
3737
*/
3838
public function getEntitiesByIds($identifier, array $values);
3939
}

‎src/Symfony/Bridge/Doctrine/Form/ChoiceList/IdReader.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,9 @@ public function isIntId()
105105
*
106106
* This method assumes that the object has a single-column ID.
107107
*
108-
* @param object $object The object.
108+
* @param object $object The object
109109
*
110-
* @return mixed The ID value.
110+
* @return mixed The ID value
111111
*/
112112
public function getIdValue($object)
113113
{
@@ -138,7 +138,7 @@ public function getIdValue($object)
138138
*
139139
* This method assumes that the object has a single-column ID.
140140
*
141-
* @return string The name of the ID field.
141+
* @return string The name of the ID field
142142
*/
143143
public function getIdField()
144144
{

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ class ORMQueryBuilderLoader implements EntityLoaderInterface
4343
* deprecated and will not be
4444
* supported anymore as of
4545
* Symfony 3.0.
46-
* @param ObjectManager $manager Deprecated.
47-
* @param string $class Deprecated.
46+
* @param ObjectManager $manager Deprecated
47+
* @param string $class Deprecated
4848
*
4949
* @throws UnexpectedTypeException
5050
*/

‎src/Symfony/Bridge/Doctrine/Form/Type/DoctrineType.php‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,9 @@ abstract class DoctrineType extends AbstractType
5656
*
5757
* For backwards compatibility, objects are cast to strings by default.
5858
*
59-
* @param object $choice The object.
59+
* @param object $choice The object
6060
*
61-
* @return string The string representation of the object.
61+
* @return string The string representation of the object
6262
*
6363
* @internal This method is public to be usable as callback. It should not
6464
* be used in user code.
@@ -75,12 +75,12 @@ public static function createChoiceLabel($choice)
7575
* a single-column integer ID. In that case, the value of the field is
7676
* the ID of the object. That ID is also used as field name.
7777
*
78-
* @param object $choice The object.
79-
* @param int|string $key The choice key.
78+
* @param object $choice The object
79+
* @param int|string $key The choice key
8080
* @param string $value The choice value. Corresponds to the object's
8181
* ID here.
8282
*
83-
* @return string The field name.
83+
* @return string The field name
8484
*
8585
* @internal This method is public to be usable as callback. It should not
8686
* be used in user code.

‎src/Symfony/Bridge/Monolog/Handler/ConsoleHandler.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ protected function getDefaultFormatter()
168168
/**
169169
* Updates the logging level based on the verbosity setting of the console output.
170170
*
171-
* @return bool Whether the handler is enabled and verbosity is not set to quiet.
171+
* @return bool Whether the handler is enabled and verbosity is not set to quiet
172172
*/
173173
private function updateLevel()
174174
{

‎src/Symfony/Bridge/ProxyManager/Tests/LazyProxy/Fixtures/php/lazy_service.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ public function __construct()
3838
*
3939
* @param bool $lazyLoad whether to try lazy-loading the service with a proxy
4040
*
41-
* @return stdClass A stdClass instance.
41+
* @return stdClass A stdClass instance
4242
*/
4343
public function getFooService($lazyLoad = true)
4444
{

0 commit comments

Comments
 (0)
0