8000 minor #24858 [3.3] More docblock fixes (nicolas-grekas) · symfony/symfony@7bcb90f · GitHub
[go: up one dir, main page]
Skip to content

Commit 7bcb90f

Browse files
nicolas-grekasnicolas-grekas
committed
minor #24858 [3.3] More docblock fixes (nicolas-grekas)
This PR was merged into the 3.3 branch. Discussion ---------- [3.3] More docblock fixes | Q | A | ------------- | --- | Branch? | 3.3 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - Commits ------- 7b6caba [3.3] More docblock fixes
2 parents d3d32d9 + 7b6caba commit 7bcb90f

File tree

19 files changed

+6
-67
lines changed

19 files changed

+6
-67
lines changed

‎src/Symfony/Bridge/Doctrine/Tests/Fixtures/Type/StringWrapper.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,6 @@
1313

1414
class StringWrapper
1515
{
16-
/**
17-
* @var string
18-
*/
1916
private $string;
2017

2118
/**

‎src/Symfony/Bridge/PhpUnit/Legacy/SymfonyTestsListenerTrait.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -340,7 +340,7 @@ public function handleError($type, $msg, $file, $line, $context = array())
340340
}
341341

342342
/**
343-
* @param Test $test
343+
* @param TestCase $test
344344
*
345345
* @return bool
346346
*/

‎src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/XmlDescriptor.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -409,8 +409,6 @@ private function getContainerDefinitionDocument(Definition $definition, $id = nu
409409
}
410410

411411
/**
412-
* @param array $arguments
413-
*
414412
* @return \DOMNode[]
415413
*/
416414
private function getArgumentNodes(array $arguments, \DOMDocument $dom)
@@ -521,10 +519,6 @@ private function getEventDispatcherListenersDocument(EventDispatcherInterface $e
521519
return $dom;
522520
}
523521

524-
/**
525-
* @param \DOMElement $element
526-
* @param array $eventListeners
527-
*/
528522
private function appendEventListenerDocument(EventDispatcherInterface $eventDispatcher, $event, \DOMElement $element, array $eventListeners)
529523
{
530524
foreach ($eventListeners as $listener) {

‎src/Symfony/Component/Cache/Adapter/PhpArrayAdapter.php

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -225,10 +225,6 @@ public function commit()
225225
}
226226

227227
/**
228-
* Generator for items.
229-
*
230-
* @param array $keys
231-
*
232228
* @return \Generator
233229
*/
234230
private function generateItems(array $keys)

‎src/Symfony/Component/Config/ResourceCheckerConfigCacheFactory.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,6 @@
1919
*/
2020
class ResourceCheckerConfigCacheFactory implements ConfigCacheFactoryInterface
2121
{
22-
/**
23-
* @var iterable|ResourceCheckerInterface[]
24-
*/
2522
private $resourceCheckers = array();
2623

2724
/**

‎src/Symfony/Component/Console/Descriptor/TextDescriptor.php

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -253,11 +253,9 @@ private function writeText($content, array $options = array())
253253
/**
254254
* Formats command aliases to show them in the command description.
255255
*
256-
* @param Command $command
257-
*
258256
* @return string
259257
*/
260-
private function getCommandAliasesText($command)
258+
private function getCommandAliasesText(Command $command)
261259
{
262260
$text = '';
263261
$aliases = $command->getAliases();

‎src/Symfony/Component/Console/Helper/Table.php

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -576,10 +576,8 @@ private function getRowColumns(array $row)
576576

577577
/**
578578
* Calculates columns widths.
579-
*
580-
* @param array $rows
581579
*/
582-
private function calculateColumnsWidth($rows)
580+
private function calculateColumnsWidth(array $rows)
583581
{
584582
for ($column = 0; $column < $this->numberOfColumns; ++$column) {
585583
$lengths = array();

‎src/Symfony/Component/HttpKernel/DataCollector/RequestDataCollector.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
*/
2525
class RequestDataCollector extends DataCollector implements EventSubscriberInterface, LateDataCollectorInterface
2626
{
27-
/** @var \SplObjectStorage */
2827
protected $controllers;
2928

3029
public function __construct()

‎src/Symfony/Component/HttpKernel/Event/FilterControllerArgumentsEvent.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,6 @@ public function getArguments()
4545
return $this->arguments;
4646
}
4747

48-
/**
49-
* @param array $arguments
50-
*/
5148
public function setArguments(array $arguments)
5249
{
5350
$this->arguments = $arguments;

‎src/Symfony/Component/HttpKernel/Event/FilterControllerEvent.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,6 @@ public function getController()
4646
return $this->controller;
4747
}
4848

49-
/**
50-
* Sets a new controller.
51-
*
52-
* @param callable $controller
53-
*/
5449
public function setController(callable $controller)
5550
{
5651
$this->controller = $controller;

‎src/Symfony/Component/HttpKernel/EventListener/AbstractTestSessionListener.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,6 @@ public function onKernelRequest(GetResponseEvent $event)
5050
/**
5151
* Checks if session was initialized and saves if current request is master
5252
* Runs on 'kernel.response' in test environment.
53-
*
54-
* @param FilterResponseEvent $event
5553
*/
5654
public function onKernelResponse(FilterResponseEvent $event)
5755
{

‎src/Symfony/Component/HttpKernel/HttpCache/AbstractSurrogate.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,6 @@ public function handle(HttpCache $cache, $uri, $alt, $ignoreErrors)
113113

114114
/**
115115
* Remove the Surrogate from the Surrogate-Control header.
116-
*
117-
* @param Response $response
118116
*/
119117
protected function removeFromControl(Response $response)
120118
{

‎src/Symfony/Component/HttpKernel/Kernel.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -495,8 +495,6 @@ protected function initializeBundles()
495495
* The extension point similar to the Bundle::build() method.
496496
*
497497
* Use this method to register compiler passes and manipulate the container during the building process.
498-
*
499-
* @param ContainerBuilder $container
500498
*/
501499
protected function build(ContainerBuilder $container)
502500
{

‎src/Symfony/Component/Routing/RouteCompiler.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -233,9 +233,6 @@ private static function compilePattern(Route $route, $pattern, $isHost)
233233
/**
234234
* Determines the longest static prefix possible for a route.
235235
*
236-
* @param Route $route
237-
* @param array $tokens
238-
*
239236
* @return string The leading static part of a route's path
240237
*/
241238
private static function determineStaticPrefix(Route $route, array $tokens)

‎src/Symfony/Component/Security/Guard/Authenticator/AbstractFormLoginAuthenticator.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,6 @@ abstract protected function getLoginUrl();
3939
/**
4040
* Override to change what happens after a bad username/password is submitted.
4141
*
42-
* @param Request $request
43-
* @param AuthenticationException $exception
44-
*
4542
* @return RedirectResponse
4643
*/
4744
public function onAuthenticationFailure(Request $request, AuthenticationException $exception)
@@ -96,9 +93,6 @@ public function supportsRememberMe()
9693
* Override to control what happens when the user hits a secure page
9794
* but isn't logged in yet.
9895
*
99-
* @param Request $request
100-
* @param AuthenticationException|null $authException
101-
*
10296
* @return RedirectResponse
10397
*/
10498
public function start(Request $request, AuthenticationException $authException = null)

‎src/Symfony/Component/Security/Guard/Firewall/GuardAuthenticationListener.php

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,6 @@ public function __construct(GuardAuthenticatorHandler $guardHandler, Authenticat
6060

6161
/**
6262
* Iterates over each authenticator to see if each wants to authenticate the request.
63-
*
64-
* @param GetResponseEvent $event
6563
*/
6664
public function handle(GetResponseEvent $event)
6765
{
@@ -160,8 +158,6 @@ private function executeGuardAuthenticator($uniqueGuardKey, GuardAuthenticatorIn
160158

161159
/**
162160
* Should be called if this listener will support remember me.
163-
*
164-
* @param RememberMeServicesInterface $rememberMeServices
165161
*/
166162
public function setRememberMeServices(RememberMeServicesInterface $rememberMeServices)
167163
{
@@ -171,11 +167,6 @@ public function setRememberMeServices(RememberMeServicesInterface $rememberMeSer
171167
/**
172168
* Checks to see if remember me is supported in the authenticator and
173169
* on the firewall. If it is, the RememberMeServicesInterface is notified.
174-
*
175-
* @param GuardAuthenticatorInterface $guardAuthenticator
176-
* @param Request $request
177-
* @param TokenInterface $token
178-
* @param Response $response
179170
*/
180171
private function triggerRememberMe(GuardAuthenticatorInterface $guardAuthenticator, Request $request, TokenInterface $token, Response $response = null)
181172
{

‎src/Symfony/Component/Serializer/Normalizer/DateTimeNormalizer.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,6 @@ class DateTimeNormalizer implements NormalizerInterface, DenormalizerInterface
2424
{
2525
const FORMAT_KEY = 'datetime_format';
2626

27-
/**
28-
* @var string
29-
*/
3027
private $format;
3128

3229
/**
@@ -112,8 +109,6 @@ public function supportsDenormalization($data, $type, $format = null)
112109
/**
113110
* Formats datetime errors.
114111
*
115-
* @param array $errors
116-
*
117112
* @return string[]
118113
*/
119114
private function formatDateTimeErrors(array $errors)

‎src/Symfony/Component/Validator/Mapping/Cache/Psr6Cache.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,6 @@
2121
*/
2222
class Psr6Cache implements CacheInterface
2323
{
24-
/**
25-
* @var CacheItemPoolInterface
26-
*/
2724
private $cacheItemPool;
2825

2926
public function __construct(CacheItemPoolInterface $cacheItemPool)

‎src/Symfony/Component/VarDumper/Cloner/Data.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public function __construct(array $data)
3434
}
3535

3636
/**
37-
* @return string the type of the value
37+
* @return string The type of the value
3838
*/
3939
public function getType()
4040
{
@@ -61,9 +61,9 @@ public function getType()
6161
}
6262

6363
/**
64-
* @param bool $recursive whether values should be resolved recursively or not
64+
* @param bool $recursive Whether values should be resolved recursively or not
6565
*
66-
* @return scalar|array|null|Data[] a native representation of the original value
66+
* @return scalar|array|null|Data[] A native representation of the original value
6767
*/
6868
public function getValue($recursive = false)
6969
{

0 commit comments

Comments
 (0)
0