10000 minor #12774 Docblock Fixes (GrahamCampbell) · symfony/symfony@c68ff54 · GitHub
[go: up one dir, main page]
Skip to content

Commit c68ff54

Browse files
fabpotfabpot
committed
minor #12774 Docblock Fixes (GrahamCampbell)
This PR was merged into the 2.3 branch. Discussion ---------- 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 fixes the docblock alignment as requested in #12760. It was also necessary for me to ensure the `@return` annotations were correctly separated in order to accurately align the `@param` annotations. Commits ------- 443307e Docblock fixes
2 parents b4a8655 + 443307e commit c68ff54

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
{

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public function __construct()
3939
* This service is shared.
4040
* This method always returns the same instance of the service.
4141
*
42-
* @param bool $lazyLoad whether to try lazy-loading the service with a proxy
42+
* @param bool $lazyLoad whether to try lazy-loading the service with a proxy
4343
*
4444
* @return stdClass A stdClass instance.
4545
*/
@@ -97,7 +97,7 @@ public function __get($name)
9797

9898
/**
9999
* @param string $name
100-
* @param mixed $value
100+
* @param mixed $value
101101
*/
102102
public function __set($name, $value)
103103
{

‎src/Symfony/Bridge/Twig/Extension/CodeExtension.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -152,9 +152,9 @@ public function fileExcerpt($file, $line)
152152
/**
153153
* Formats a file path.
154154
*
155-
* @param string $file An absolute file path
156-
* @param int $line The line number
157-
* @param string $text Use this text for the link rather than the file path
155+
* @param string $file An absolute file path
156+
* @param int $line The line number
157+
* @param string $text Use this text for the link rather than the file path
158158
*
159159
* @return string
160160
*/
@@ -187,8 +187,8 @@ public function formatFile($file, $line, $text = null)
187187
/**
188188
* Returns the link for a given file/line pair.
189189
*
190-
* @param string $file An absolute file path< 10000 /span>
191-
* @param int $line The line number
190+
* @param string $file An absolute file path
191+
* @param int $line The line number
192192
*
193193
* @return string A link of false
194194
*/

‎src/Symfony/Bridge/Twig/Extension/FormExtension.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ public function humanize($text)
137137
* @param ChoiceView $choice The choice to check.
138138
* @param string|array $selectedValue The selected value to compare.
139139
*
140-
* @return bool Whether the choice is selected.
140+
* @return bool Whether the choice is selected.
141141
*
142142
* @see ChoiceView::isSelected()
143143
*/

‎src/Symfony/Bridge/Twig/Extension/HttpKernelExtension.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ public function getFunctions()
4545
/**
4646
* Renders a fragment.
4747
*
48-
* @param string|ControllerReference $uri A URI as a string or a ControllerReference instance
49-
* @param array $options An array of options
48+
* @param string|ControllerReference $uri A URI as a string or a ControllerReference instance
49+
* @param array $options An array of options
5050
*
5151
* @return string The fragment content
5252
*

‎src/Symfony/Bridge/Twig/Form/TwigRendererEngine.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ public function renderBlock(FormView $view, $resource, $blockName, array $variab
7474
* @param FormView $view The form view for finding the applying themes.
7575
* @param string $blockName The name of the block to load.
7676
*
77-
* @return bool True if the resource could be loaded, false otherwise.
77+
* @return bool True if the resource could be loaded, false otherwise.
7878
*/
7979
protected function loadResourceForBlockName($cacheKey, FormView $view, $blockName)
8080
{

‎src/Symfony/Bridge/Twig/TwigEngine.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ public function stream($name, array $parameters = array())
7171
*
7272
* @param mixed $name A template name
7373
*
74-
* @return bool true if the template exists, false otherwise
74+
* @return bool true if the template exists, false otherwise
7575
*/
7676
public function exists($name)
7777
{
@@ -99,7 +99,7 @@ public function exists($name)
9999
*
100100
* @param string $name A template name
101101
*
102-
* @return bool True if this class supports the given resource, false otherwise
102+
* @return bool True if this class supports the given resource, false otherwise
103103
*/
104104
public function supports($name)
105105
{

‎src/Symfony/Bundle/FrameworkBundle/CacheWarmer/RouterCacheWarmer.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public function warmUp($cacheDir)
4949
/**
5050
* Checks whether this warmer is optional or not.
5151
*
52-
* @return bool always true
52+
* @return bool always true
5353
*/
5454
public function isOptional()
5555
{

‎src/Symfony/Bundle/FrameworkBundle/CacheWarmer/TemplatePathsCacheWarmer.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ public function warmUp($cacheDir)
5555
/**
5656
* Checks whether this warmer is optional or not.
5757
*
58-
* @return bool always true
58+
* @return bool always true
5959
*/
6060
public function isOptional()
6161
{

‎src/Symfony/Bundle/FrameworkBundle/Console/Application.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public function getKernel()
6363
* @param InputInterface $input An Input instance
6464
* @param OutputInterface $output An Output instance
6565
*
66-
* @return int 0 if everything went fine, or an error code
66+
* @return int 0 if everything went fine, or an error code
6767
*/
6868
public function doRun(InputInterface $input, OutputInterface $output)
6969
{

‎src/Symfony/Bundle/FrameworkBundle/Controller/Controller.php

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ class Controller extends ContainerAware
3636
/**
3737
* Generates a URL from the given parameters.
3838
*
39-
* @param string $route The name of the route
40-
* @param mixed $parameters An array of parameters
41-
* @param bool|string $referenceType The type of reference (one of the constants in UrlGeneratorInterface)
39+
* @param string $route The name of the route
40+
* @param mixed $parameters An array of parameters
41+
* @param bool|string $referenceType The type of reference (one of the constants in UrlGeneratorInterface)
4242
*
4343
* @return string The generated URL
4444
*
@@ -69,8 +69,8 @@ public function forward($controller, array $path = array(), array $query = array
6969
/**
7070
* Returns a RedirectResponse to the given URL.
7171
*
72-
* @param string $url The URL to redirect to
73-
* @param int $status The status code to use for the Response
72+
* @param string $url The URL to redirect to
73+
* @param int $status The status code to use for the Response
7474
*
7575
* @return RedirectResponse
7676
*/
@@ -139,7 +139,7 @@ public function stream($view, array $parameters = array(), StreamedResponse $res
139139
*
140140
* throw $this->createNotFoundException('Page not found!');
141141
*
142-
* @param string $message A message
142+
* @param string $message A message
143143
* @param \Exception $previous The previous exception
144144
*
145145
* @return NotFoundHttpException
@@ -233,7 +233,7 @@ public function getUser()
233233
*
234234
* @param string $id The service id
235235
*
236-
* @return bool true if the service id is defined, false otherwise
236+
* @return bool true if the service id is defined, false otherwise
237237
*/
238238
public function has($id)
239239
{

‎src/Symfony/Bundle/FrameworkBundle/Controller/ControllerResolver.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ public function __construct(ContainerInterface $container, ControllerNameParser
4848
*
4949
* @return mixed A PHP callable
5050
*
51-
* @throws \LogicException When the name could not be parsed
51+
* @throws \LogicException When the name could not be parsed
5252
* @throws \InvalidArgumentException When the controller class does not exist
5353
*/
5454
protected function createController($controller)

‎src/Symfony/Bundle/FrameworkBundle/Controller/RedirectController.php

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ class RedirectController extends ContainerAware
3434
* In case the route name is empty, the status code will be 404 when permanent is false
3535
* and 410 otherwise.
3636
*
37-
* @param Request $request The request instance
38-
* @param string $route The route name to redirect to
39-
* @param bool $permanent Whether the redirection is permanent
40-
* @param bool|array $ignoreAttributes Whether to ignore attributes or an array of attributes to ignore
37+
* @param Request $request The request instance
38+
* @param string $route The route name to redirect to
39+
* @param bool $permanent Whether the redirection is permanent
40+
* @param bool|array $ignoreAttributes Whether to ignore attributes or an array of attributes to ignore
4141
*
4242
* @return Response A Response instance
4343
*
@@ -70,12 +70,12 @@ public function redirectAction(Request $request, $route, $permanent = false, $ig
7070
* In case the path is empty, the status code will be 404 when permanent is false
7171
* and 410 otherwise.
7272
*
73-
* @param Request $request The request instance
74-
* @param string $path The absolute path or URL to redirect to
75-
* @param bool $permanent Whether the redirect is permanent or not
76-
* @param string|null $scheme The URL scheme (null to keep the current one)
77-
* @param int|null $httpPort The HTTP port (null to keep the current one for the same scheme or the configured port in the container)
78-
* @param int|null $httpsPort The HTTPS port (null to keep the current one for the same scheme or the configured port in the container)
73+
* @param Request $request The request instance
74+
* @param string $path The absolute path or URL to redirect to
75+
* @param bool $permanent Whether the redirect is permanent or not
76+
* @param string|null $scheme The URL scheme (null to keep the current one)
77+
* @param int|null $httpPort The HTTP port (null to keep the current one for the same scheme or the configured port in the container)
78+
* @param int|null $httpsPort The HTTPS port (null to keep the current one for the same scheme or the configured port in the container)
7979
*
8080
* @return Response A Response instance
8181
*

‎src/Symfony/Bundle/FrameworkBundle/Controller/TemplateController.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ class TemplateController extends ContainerAware
2424
/**
2525
* Renders a template.
2626
*
27-
* @param string $template The template name
28-
* @param int|null $maxAge Max age for client caching
29-
* @param int|null $sharedAge Max age for shared (proxy) caching
30-
* @param bool|null $private Whether or not caching should apply for client caches only
27+
* @param string $template The template name
28+
* @param int|null $maxAge Max age for client caching
29+
* @param int|null $sharedAge Max age for shared (proxy) caching
30+
* @param bool|null $private Whether or not caching should apply for client caches only
3131
*
3232
* @return Response A Response instance
3333
*/

‎src/Symfony/Bundle/FrameworkBundle/Templating/GlobalVariables.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ public function getEnvironment()
108108
/**
109109
* Returns the current app debug mode.
110110
*
111-
* @return bool The current debug mode
111+
* @return bool The current debug mode
112112
*/
113113
public function getDebug()
114114
{

0 commit comments

Comments
 (0)
0