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
2017-11-07 15:19:06 +01:00 · 2017-11-07 15:19:06 +01:00 · 7bcb90f75c
commit 7bcb90f75c
parent d3d32d9deb 7b6cabad22
19 changed files with 6 additions and 67 deletions
--- a/src/Symfony/Bridge/Doctrine/Tests/Fixtures/Type/StringWrapper.php
+++ b/src/Symfony/Bridge/Doctrine/Tests/Fixtures/Type/StringWrapper.php
@ -13,9 +13,6 @@ namespace Symfony\Bridge\Doctrine\Tests\Fixtures\Type;

 class StringWrapper
 {
-    /**
-     * @var string
-     */
    private $string;

    /**
--- a/src/Symfony/Bridge/PhpUnit/Legacy/SymfonyTestsListenerTrait.php
+++ b/src/Symfony/Bridge/PhpUnit/Legacy/SymfonyTestsListenerTrait.php
@ -340,7 +340,7 @@ class SymfonyTestsListenerTrait
    }

    /**
-     * @param Test $test
+     * @param TestCase $test
     *
     * @return bool
     */
--- a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/XmlDescriptor.php
+++ b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/XmlDescriptor.php
@ -409,8 +409,6 @@ class XmlDescriptor extends Descriptor
    }

    /**
-     * @param array $arguments
-     *
     * @return \DOMNode[]
     */
    private function getArgumentNodes(array $arguments, \DOMDocument $dom)
@ -521,10 +519,6 @@ class XmlDescriptor extends Descriptor
        return $dom;
    }

-    /**
-     * @param \DOMElement $element
-     * @param array       $eventListeners
-     */
    private function appendEventListenerDocument(EventDispatcherInterface $eventDispatcher, $event, \DOMElement $element, array $eventListeners)
    {
        foreach ($eventListeners as $listener) {
--- a/src/Symfony/Component/Cache/Adapter/PhpArrayAdapter.php
+++ b/src/Symfony/Component/Cache/Adapter/PhpArrayAdapter.php
@ -225,10 +225,6 @@ class PhpArrayAdapter implements AdapterInterface
    }

    /**
-     * Generator for items.
-     *
-     * @param array $keys
-     *
     * @return \Generator
     */
    private function generateItems(array $keys)
--- a/src/Symfony/Component/Config/ResourceCheckerConfigCacheFactory.php
+++ b/src/Symfony/Component/Config/ResourceCheckerConfigCacheFactory.php
@ -19,9 +19,6 @@ namespace Symfony\Component\Config;
 */
 class ResourceCheckerConfigCacheFactory implements ConfigCacheFactoryInterface
 {
-    /**
-     * @var iterable|ResourceCheckerInterface[]
-     */
    private $resourceCheckers = array();

    /**
--- a/src/Symfony/Component/Console/Descriptor/TextDescriptor.php
+++ b/src/Symfony/Component/Console/Descriptor/TextDescriptor.php
@ -253,11 +253,9 @@ class TextDescriptor extends Descriptor
    /**
     * Formats command aliases to show them in the command description.
     *
-     * @param Command $command
-     *
     * @return string
     */
-    private function getCommandAliasesText($command)
+    private function getCommandAliasesText(Command $command)
    {
        $text = '';
        $aliases = $command->getAliases();
--- a/src/Symfony/Component/Console/Helper/Table.php
+++ b/src/Symfony/Component/Console/Helper/Table.php
@ -576,10 +576,8 @@ class Table

    /**
     * Calculates columns widths.
-     *
-     * @param array $rows
     */
-    private function calculateColumnsWidth($rows)
+    private function calculateColumnsWidth(array $rows)
    {
        for ($column = 0; $column < $this->numberOfColumns; ++$column) {
            $lengths = array();
--- a/src/Symfony/Component/HttpKernel/DataCollector/RequestDataCollector.php
+++ b/src/Symfony/Component/HttpKernel/DataCollector/RequestDataCollector.php
@ -24,7 +24,6 @@ use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 */
 class RequestDataCollector extends DataCollector implements EventSubscriberInterface, LateDataCollectorInterface
 {
-    /** @var \SplObjectStorage */
    protected $controllers;

    public function __construct()
--- a/src/Symfony/Component/HttpKernel/Event/FilterControllerArgumentsEvent.php
+++ b/src/Symfony/Component/HttpKernel/Event/FilterControllerArgumentsEvent.php
@ -45,9 +45,6 @@ class FilterControllerArgumentsEvent extends FilterControllerEvent
        return $this->arguments;
    }

-    /**
-     * @param array $arguments
-     */
    public function setArguments(array $arguments)
    {
        $this->arguments = $arguments;
--- a/src/Symfony/Component/HttpKernel/Event/FilterControllerEvent.php
+++ b/src/Symfony/Component/HttpKernel/Event/FilterControllerEvent.php
@ -46,11 +46,6 @@ class FilterControllerEvent extends KernelEvent
        return $this->controller;
    }

-    /**
-     * Sets a new controller.
-     *
-     * @param callable $controller
-     */
    public function setController(callable $controller)
    {
        $this->controller = $controller;
--- a/src/Symfony/Component/HttpKernel/EventListener/AbstractTestSessionListener.php
+++ b/src/Symfony/Component/HttpKernel/EventListener/AbstractTestSessionListener.php
@ -50,8 +50,6 @@ abstract class AbstractTestSessionListener implements EventSubscriberInterface
    /**
     * Checks if session was initialized and saves if current request is master
     * Runs on 'kernel.response' in test environment.
-     *
-     * @param FilterResponseEvent $event
     */
    public function onKernelResponse(FilterResponseEvent $event)
    {
--- a/src/Symfony/Component/HttpKernel/HttpCache/AbstractSurrogate.php
+++ b/src/Symfony/Component/HttpKernel/HttpCache/AbstractSurrogate.php
@ -113,8 +113,6 @@ abstract class AbstractSurrogate implements SurrogateInterface

    /**
     * Remove the Surrogate from the Surrogate-Control header.
-     *
-     * @param Response $response
     */
    protected function removeFromControl(Response $response)
    {
--- a/src/Symfony/Component/HttpKernel/Kernel.php
+++ b/src/Symfony/Component/HttpKernel/Kernel.php
@ -495,8 +495,6 @@ abstract class Kernel implements KernelInterface, TerminableInterface
     * The extension point similar to the Bundle::build() method.
     *
     * Use this method to register compiler passes and manipulate the container during the building process.
-     *
-     * @param ContainerBuilder $container
     */
    protected function build(ContainerBuilder $container)
    {
--- a/src/Symfony/Component/Routing/RouteCompiler.php
+++ b/src/Symfony/Component/Routing/RouteCompiler.php
@ -233,9 +233,6 @@ class RouteCompiler implements RouteCompilerInterface
    /**
     * Determines the longest static prefix possible for a route.
     *
-     * @param Route $route
-     * @param array $tokens
-     *
     * @return string The leading static part of a route's path
     */
    private static function determineStaticPrefix(Route $route, array $tokens)
--- a/src/Symfony/Component/Security/Guard/Authenticator/AbstractFormLoginAuthenticator.php
+++ b/src/Symfony/Component/Security/Guard/Authenticator/AbstractFormLoginAuthenticator.php
@ -39,9 +39,6 @@ abstract class AbstractFormLoginAuthenticator extends AbstractGuardAuthenticator
    /**
     * Override to change what happens after a bad username/password is submitted.
     *
-     * @param Request                 $request
-     * @param AuthenticationException $exception
-     *
     * @return RedirectResponse
     */
    public function onAuthenticationFailure(Request $request, AuthenticationException $exception)
@ -96,9 +93,6 @@ abstract class AbstractFormLoginAuthenticator extends AbstractGuardAuthenticator
     * Override to control what happens when the user hits a secure page
     * but isn't logged in yet.
     *
-     * @param Request                      $request
-     * @param AuthenticationException|null $authException
-     *
     * @return RedirectResponse
     */
    public function start(Request $request, AuthenticationException $authException = null)
--- a/src/Symfony/Component/Security/Guard/Firewall/GuardAuthenticationListener.php
+++ b/src/Symfony/Component/Security/Guard/Firewall/GuardAuthenticationListener.php
@ -60,8 +60,6 @@ class GuardAuthenticationListener implements ListenerInterface

    /**
     * Iterates over each authenticator to see if each wants to authenticate the request.
-     *
-     * @param GetResponseEvent $event
     */
    public function handle(GetResponseEvent $event)
    {
@ -160,8 +158,6 @@ class GuardAuthenticationListener implements ListenerInterface

    /**
     * Should be called if this listener will support remember me.
-     *
-     * @param RememberMeServicesInterface $rememberMeServices
     */
    public function setRememberMeServices(RememberMeServicesInterface $rememberMeServices)
    {
@ -171,11 +167,6 @@ class GuardAuthenticationListener implements ListenerInterface
    /**
     * Checks to see if remember me is supported in the authenticator and
     * on the firewall. If it is, the RememberMeServicesInterface is notified.
-     *
-     * @param GuardAuthenticatorInterface $guardAuthenticator
-     * @param Request                     $request
-     * @param TokenInterface              $token
-     * @param Response                    $response
     */
    private function triggerRememberMe(GuardAuthenticatorInterface $guardAuthenticator, Request $request, TokenInterface $token, Response $response = null)
    {
--- a/src/Symfony/Component/Serializer/Normalizer/DateTimeNormalizer.php
+++ b/src/Symfony/Component/Serializer/Normalizer/DateTimeNormalizer.php
@ -24,9 +24,6 @@ class DateTimeNormalizer implements NormalizerInterface, DenormalizerInterface
 {
    const FORMAT_KEY = 'datetime_format';

-    /**
-     * @var string
-     */
    private $format;

    /**
@ -112,8 +109,6 @@ class DateTimeNormalizer implements NormalizerInterface, DenormalizerInterface
    /**
     * Formats datetime errors.
     *
-     * @param array $errors
-     *
     * @return string[]
     */
    private function formatDateTimeErrors(array $errors)
--- a/src/Symfony/Component/Validator/Mapping/Cache/Psr6Cache.php
+++ b/src/Symfony/Component/Validator/Mapping/Cache/Psr6Cache.php
@ -21,9 +21,6 @@ use Symfony\Component\Validator\Mapping\ClassMetadata;
 */
 class Psr6Cache implements CacheInterface
 {
-    /**
-     * @var CacheItemPoolInterface
-     */
    private $cacheItemPool;

    public function __construct(CacheItemPoolInterface $cacheItemPool)
--- a/src/Symfony/Component/VarDumper/Cloner/Data.php
+++ b/src/Symfony/Component/VarDumper/Cloner/Data.php
@ -34,7 +34,7 @@ class Data implements \ArrayAccess, \Countable, \IteratorAggregate
    }

    /**
-     * @return string the type of the value
+     * @return string The type of the value
     */
    public function getType()
    {
@ -61,9 +61,9 @@ class Data implements \ArrayAccess, \Countable, \IteratorAggregate
    }

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