minor symfony#24858 [3.3] More docblock fixes (nicolas-grekas)

nicolas-grekas · nicolas-grekas · commit 7bcb90f75c17 · 2017-11-07T15:19:06.000+01:00
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
diff --git a/src/Symfony/Bridge/Doctrine/Tests/Fixtures/Type/StringWrapper.php b/src/Symfony/Bridge/Doctrine/Tests/Fixtures/Type/StringWrapper.php
@@ -13,9 +13,6 @@
 
 class StringWrapper
 {
-    /**
-     * @var string
-     */
     private $string;
 
     /**
diff --git a/src/Symfony/Bridge/PhpUnit/Legacy/SymfonyTestsListenerTrait.php b/src/Symfony/Bridge/PhpUnit/Legacy/SymfonyTestsListenerTrait.php
@@ -340,7 +340,7 @@ public function handleError($type, $msg, $file, $line, $context = array())
     }
 
     /**
-     * @param Test $test
+     * @param TestCase $test
      *
      * @return bool
      */
diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/XmlDescriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/XmlDescriptor.php
@@ -409,8 +409,6 @@ private function getContainerDefinitionDocument(Definition $definition, $id = nu
     }
 
     /**
-     * @param array $arguments
-     *
      * @return \DOMNode[]
      */
     private function getArgumentNodes(array $arguments, \DOMDocument $dom)
@@ -521,10 +519,6 @@ private function getEventDispatcherListenersDocument(EventDispatcherInterface $e
         return $dom;
     }
 
-    /**
-     * @param \DOMElement $element
-     * @param array       $eventListeners
-     */
     private function appendEventListenerDocument(EventDispatcherInterface $eventDispatcher, $event, \DOMElement $element, array $eventListeners)
     {
         foreach ($eventListeners as $listener) {
diff --git a/src/Symfony/Component/Cache/Adapter/PhpArrayAdapter.php b/src/Symfony/Component/Cache/Adapter/PhpArrayAdapter.php
@@ -225,10 +225,6 @@ public function commit()
     }
 
     /**
-     * Generator for items.
-     *
-     * @param array $keys
-     *
      * @return \Generator
      */
     private function generateItems(array $keys)
diff --git a/src/Symfony/Component/Config/ResourceCheckerConfigCacheFactory.php b/src/Symfony/Component/Config/ResourceCheckerConfigCacheFactory.php
@@ -19,9 +19,6 @@
  */
 class ResourceCheckerConfigCacheFactory implements ConfigCacheFactoryInterface
 {
-    /**
-     * @var iterable|ResourceCheckerInterface[]
-     */
     private $resourceCheckers = array();
 
     /**
diff --git a/src/Symfony/Component/Console/Descriptor/TextDescriptor.php b/src/Symfony/Component/Console/Descriptor/TextDescriptor.php
@@ -253,11 +253,9 @@ private function writeText($content, array $options = array())
     /**
      * 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();
diff --git a/src/Symfony/Component/Console/Helper/Table.php b/src/Symfony/Component/Console/Helper/Table.php
@@ -576,10 +576,8 @@ private function getRowColumns(array $row)
 
     /**
      * Calculates columns widths.
-     *
-     * @param array $rows
      */
-    private function calculateColumnsWidth($rows)
+    private function calculateColumnsWidth(array $rows)
     {
         for ($column = 0; $column < $this->numberOfColumns; ++$column) {
             $lengths = array();
diff --git a/src/Symfony/Component/HttpKernel/DataCollector/RequestDataCollector.php b/src/Symfony/Component/HttpKernel/DataCollector/RequestDataCollector.php
@@ -24,7 +24,6 @@
  */
 class RequestDataCollector extends DataCollector implements EventSubscriberInterface, LateDataCollectorInterface
 {
-    /** @var \SplObjectStorage */
     protected $controllers;
 
     public function __construct()
diff --git a/src/Symfony/Component/HttpKernel/Event/FilterControllerArgumentsEvent.php b/src/Symfony/Component/HttpKernel/Event/FilterControllerArgumentsEvent.php
@@ -45,9 +45,6 @@ public function getArguments()
         return $this->arguments;
     }
 
-    /**
-     * @param array $arguments
-     */
     public function setArguments(array $arguments)
     {
         $this->arguments = $arguments;
diff --git a/src/Symfony/Component/HttpKernel/Event/FilterControllerEvent.php b/src/Symfony/Component/HttpKernel/Event/FilterControllerEvent.php
@@ -46,11 +46,6 @@ public function getController()
         return $this->controller;
     }
 
-    /**
-     * Sets a new controller.
-     *
-     * @param callable $controller
-     */
     public function setController(callable $controller)
     {
         $this->controller = $controller;
diff --git a/src/Symfony/Component/HttpKernel/EventListener/AbstractTestSessionListener.php b/src/Symfony/Component/HttpKernel/EventListener/AbstractTestSessionListener.php
@@ -50,8 +50,6 @@ public function onKernelRequest(GetResponseEvent $event)
     /**
      * 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)
     {
diff --git a/src/Symfony/Component/HttpKernel/HttpCache/AbstractSurrogate.php b/src/Symfony/Component/HttpKernel/HttpCache/AbstractSurrogate.php
@@ -113,8 +113,6 @@ public function handle(HttpCache $cache, $uri, $alt, $ignoreErrors)
 
     /**
      * Remove the Surrogate from the Surrogate-Control header.
-     *
-     * @param Response $response
      */
     protected function removeFromControl(Response $response)
     {
diff --git a/src/Symfony/Component/HttpKernel/Kernel.php b/src/Symfony/Component/HttpKernel/Kernel.php
@@ -495,8 +495,6 @@ protected function initializeBundles()
      * 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)
     {
diff --git a/src/Symfony/Component/Routing/RouteCompiler.php b/src/Symfony/Component/Routing/RouteCompiler.php
@@ -233,9 +233,6 @@ private static function compilePattern(Route $route, $pattern, $isHost)
     /**
      * 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)
diff --git a/src/Symfony/Component/Security/Guard/Authenticator/AbstractFormLoginAuthenticator.php b/src/Symfony/Component/Security/Guard/Authenticator/AbstractFormLoginAuthenticator.php
@@ -39,9 +39,6 @@ abstract protected function getLoginUrl();
     /**
      * 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 @@ public function supportsRememberMe()
      * 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)
diff --git a/src/Symfony/Component/Security/Guard/Firewall/GuardAuthenticationListener.php b/src/Symfony/Component/Security/Guard/Firewall/GuardAuthenticationListener.php
@@ -60,8 +60,6 @@ public function __construct(GuardAuthenticatorHandler $guardHandler, Authenticat
 
     /**
      * 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 @@ private function executeGuardAuthenticator($uniqueGuardKey, GuardAuthenticatorIn
 
     /**
      * Should be called if this listener will support remember me.
-     *
-     * @param RememberMeServicesInterface $rememberMeServices
      */
     public function setRememberMeServices(RememberMeServicesInterface $rememberMeServices)
     {
@@ -171,11 +167,6 @@ public function setRememberMeServices(RememberMeServicesInterface $rememberMeSer
     /**
      * 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)
     {
diff --git 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 @@ public function supportsDenormalization($data, $type, $format = null)
     /**
      * Formats datetime errors.
      *
-     * @param array $errors
-     *
      * @return string[]
      */
     private function formatDateTimeErrors(array $errors)
diff --git a/src/Symfony/Component/Validator/Mapping/Cache/Psr6Cache.php b/src/Symfony/Component/Validator/Mapping/Cache/Psr6Cache.php
@@ -21,9 +21,6 @@
  */
 class Psr6Cache implements CacheInterface
 {
-    /**
-     * @var CacheItemPoolInterface
-     */
     private $cacheItemPool;
 
     public function __construct(CacheItemPoolInterface $cacheItemPool)
diff --git a/src/Symfony/Component/VarDumper/Cloner/Data.php b/src/Symfony/Component/VarDumper/Cloner/Data.php
@@ -34,7 +34,7 @@ public function __construct(array $data)
     }
 
     /**
-     * @return string the type of the value
+     * @return string The type of the value
      */
     public function getType()
     {
@@ -61,9 +61,9 @@ public function getType()
     }
 
     /**
-     * @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)
     {

Original file line number	Diff line number	Diff line change
`@@ -13,9 +13,6 @@`
`13`	`13`
`14`	`14`	`class StringWrapper`
`15`	`15`	`{`
`16`		`- /**`
`17`		`- * @var string`
`18`		`- */`
`19`	`16`	`private $string;`
`20`	`17`
`21`	`18`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -340,7 +340,7 @@ public function handleError($type, $msg, $file, $line, $context = array())`
`340`	`340`	`}`
`341`	`341`
`342`	`342`	`/**`
`343`		`- * @param Test $test`
	`343`	`+ * @param TestCase $test`
`344`	`344`	`*`
`345`	`345`	`* @return bool`
`346`	`346`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -409,8 +409,6 @@ private function getContainerDefinitionDocument(Definition $definition, $id = nu`
`409`	`409`	`}`
`410`	`410`
`411`	`411`	`/**`
`412`		`- * @param array $arguments`
`413`		`- *`
`414`	`412`	`* @return \DOMNode[]`
`415`	`413`	`*/`
`416`	`414`	`private function getArgumentNodes(array $arguments, \DOMDocument $dom)`
`@@ -521,10 +519,6 @@ private function getEventDispatcherListenersDocument(EventDispatcherInterface $e`
`521`	`519`	`return $dom;`
`522`	`520`	`}`
`523`	`521`
`524`		`- /**`
`525`		`- * @param \DOMElement $element`
`526`		`- * @param array $eventListeners`
`527`		`- */`
`528`	`522`	`private function appendEventListenerDocument(EventDispatcherInterface $eventDispatcher, $event, \DOMElement $element, array $eventListeners)`
`529`	`523`	`{`
`530`	`524`	`foreach ($eventListeners as $listener) {`
Original file line number	Diff line number	Diff line change
`@@ -19,9 +19,6 @@`
`19`	`19`	`*/`
`20`	`20`	`class ResourceCheckerConfigCacheFactory implements ConfigCacheFactoryInterface`
`21`	`21`	`{`
`22`		`- /**`
`23`		`- * @var iterable\|ResourceCheckerInterface[]`
`24`		`- */`
`25`	`22`	`private $resourceCheckers = array();`
`26`	`23`
`27`	`24`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -253,11 +253,9 @@ private function writeText($content, array $options = array())`
`253`	`253`	`/**`
`254`	`254`	`* Formats command aliases to show them in the command description.`
`255`	`255`	`*`
`256`		`- * @param Command $command`
`257`		`- *`
`258`	`256`	`* @return string`
`259`	`257`	`*/`
`260`		`- private function getCommandAliasesText($command)`
	`258`	`+ private function getCommandAliasesText(Command $command)`
`261`	`259`	`{`
`262`	`260`	`$text = '';`
`263`	`261`	`$aliases = $command->getAliases();`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,6 @@`
`24`	`24`	`*/`
`25`	`25`	`class RequestDataCollector extends DataCollector implements EventSubscriberInterface, LateDataCollectorInterface`
`26`	`26`	`{`
`27`		`- /** @var \SplObjectStorage */`
`28`	`27`	`protected $controllers;`
`29`	`28`
`30`	`29`	`public function __construct()`
Original file line number	Diff line number	Diff line change
`@@ -45,9 +45,6 @@ public function getArguments()`
`45`	`45`	`return $this->arguments;`
`46`	`46`	`}`
`47`	`47`
`48`		`- /**`
`49`		`- * @param array $arguments`
`50`		`- */`
`51`	`48`	`public function setArguments(array $arguments)`
`52`	`49`	`{`
`53`	`50`	`$this->arguments = $arguments;`
Original file line number	Diff line number	Diff line change
`@@ -46,11 +46,6 @@ public function getController()`
`46`	`46`	`return $this->controller;`
`47`	`47`	`}`
`48`	`48`
`49`		`- /**`
`50`		`- * Sets a new controller.`
`51`		`- *`
`52`		`- * @param callable $controller`
`53`		`- */`
`54`	`49`	`public function setController(callable $controller)`
`55`	`50`	`{`
`56`	`51`	`$this->controller = $controller;`