[2.7] More docblock fixes

nicolas-grekas · nicolas-grekas · commit ac671ac68cfb · 2017-11-07T15:04:08.000+01:00
diff --git a/src/Symfony/Component/BrowserKit/Cookie.php b/src/Symfony/Component/BrowserKit/Cookie.php
@@ -80,10 +80,6 @@ public function __construct($name, $value, $expires = null, $path = null, $domai
 
     /**
      * Returns the HTTP representation of the Cookie.
-     *
-     * @return string The HTTP representation of the Cookie
-     *
-     * @throws \UnexpectedValueException
      */
     public function __toString()
     {
diff --git a/src/Symfony/Component/Console/Helper/Table.php b/src/Symfony/Component/Console/Helper/Table.php
@@ -419,8 +419,6 @@ private function fillNextRows(array $rows, $line)
     /**
      * fill cells for a row that contains colspan > 1.
      *
-     * @param array|\Traversable $row
-     *
      * @return array
      */
     private function fillCells($row)
diff --git a/src/Symfony/Component/DependencyInjection/Dumper/GraphvizDumper.php b/src/Symfony/Component/DependencyInjection/Dumper/GraphvizDumper.php
@@ -54,8 +54,6 @@ class GraphvizDumper extends Dumper
      *  * node.definition: The default options for services that are defined via service definition instances
      *  * node.missing: The default options for missing services
      *
-     * @param array $options An array of options
-     *
      * @return string The dot representation of the service container
      */
     public function dump(array $options = array())
diff --git a/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php b/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php
@@ -62,7 +62,7 @@ class PhpDumper extends Dumper
     private $expressionLanguageProviders = array();
 
     /**
-     * @var \Symfony\Component\DependencyInjection\LazyProxy\PhpDumper\DumperInterface
+     * @var ProxyDumper
      */
     private $proxyDumper;
 
diff --git a/src/Symfony/Component/DependencyInjection/Variable.php b/src/Symfony/Component/DependencyInjection/Variable.php
@@ -36,11 +36,6 @@ public function __construct($name)
         $this->name = $name;
     }
 
-    /**
-     * Converts the object to a string.
-     *
-     * @return string
-     */
     public function __toString()
     {
         return $this->name;
diff --git a/src/Symfony/Component/Filesystem/Tests/FilesystemTest.php b/src/Symfony/Component/Filesystem/Tests/FilesystemTest.php
@@ -838,9 +838,6 @@ public function testMakePathRelative($endPath, $startPath, $expectedPath)
         $this->assertEquals($expectedPath, $path);
     }
 
-    /**
-     * @return array
-     */
     public function providePathsForMakePathRelative()
     {
         $paths = array(
@@ -1078,9 +1075,6 @@ public function testIsAbsolutePath($path, $expectedResult)
         $this->assertEquals($expectedResult, $result);
     }
 
-    /**
-     * @return array
-     */
     public function providePathsForIsAbsolutePath()
     {
         return array(
diff --git a/src/Symfony/Component/Form/Extension/Core/Type/ChoiceType.php b/src/Symfony/Component/Form/Extension/Core/Type/ChoiceType.php
@@ -444,10 +444,6 @@ public function getName()
 
     /**
      * Adds the sub fields for an expanded choice field.
-     *
-     * @param FormBuilderInterface $builder     The form builder
-     * @param array                $choiceViews The choice view objects
-     * @param array                $options     The build options
      */
     private function addSubForms(FormBuilderInterface $builder, array $choiceViews, array $options)
     {
@@ -468,11 +464,6 @@ private function addSubForms(FormBuilderInterface $builder, array $choiceViews,
     }
 
     /**
-     * @param FormBuilderInterface $builder
-     * @param                      $name
-     * @param                      $choiceView
-     * @param array                $options
-     *
      * @return mixed
      */
     private function addSubForm(FormBuilderInterface $builder, $name, ChoiceView $choiceView, array $options)
diff --git a/src/Symfony/Component/Form/FormEvent.php b/src/Symfony/Component/Form/FormEvent.php
@@ -21,12 +21,6 @@ class FormEvent extends Event
     private $form;
     protected $data;
 
-    /**
-     * Constructs an event.
-     *
-     * @param FormInterface $form The associated form
-     * @param mixed         $data The data
-     */
     public function __construct(FormInterface $form, $data)
     {
         $this->form = $form;
diff --git a/src/Symfony/Component/Form/Tests/Extension/Core/DataMapper/PropertyPathMapperTest.php b/src/Symfony/Component/Form/Tests/Extension/Core/DataMapper/PropertyPathMapperTest.php
@@ -41,8 +41,6 @@ protected function setUp()
     }
 
     /**
-     * @param $path
-     *
      * @return \PHPUnit_Framework_MockObject_MockObject
      */
     private function getPropertyPath($path)
diff --git a/src/Symfony/Component/HttpKernel/DataCollector/RequestDataCollector.php b/src/Symfony/Component/HttpKernel/DataCollector/RequestDataCollector.php
@@ -19,8 +19,6 @@
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
 /**
- * RequestDataCollector.
- *
  * @author Fabien Potencier <fabien@symfony.com>
  */
 class RequestDataCollector extends DataCollector implements EventSubscriberInterface
diff --git a/src/Symfony/Component/HttpKernel/Event/FilterControllerEvent.php b/src/Symfony/Component/HttpKernel/Event/FilterControllerEvent.php
@@ -27,9 +27,6 @@
  */
 class FilterControllerEvent extends KernelEvent
 {
-    /**
-     * The current controller.
-     */
     private $controller;
 
     public function __construct(HttpKernelInterface $kernel, $controller, Request $request, $requestType)
diff --git a/src/Symfony/Component/HttpKernel/HttpCache/HttpCache.php b/src/Symfony/Component/HttpKernel/HttpCache/HttpCache.php
@@ -67,11 +67,6 @@ class HttpCache implements HttpKernelInterface, TerminableInterface
      *                            the cache can serve a stale response when an error is encountered (default: 60).
      *                            This setting is overridden by the stale-if-error HTTP Cache-Control extension
      *                            (see RFC 5861).
-     *
-     * @param HttpKernelInterface $kernel    An HttpKernelInterface instance
-     * @param StoreInterface      $store     A Store instance
-     * @param SurrogateInterface  $surrogate A SurrogateInterface instance
-     * @param array               $options   An array of options
      */
     public function __construct(HttpKernelInterface $kernel, StoreInterface $store, SurrogateInterface $surrogate = null, array $options = array())
     {
diff --git a/src/Symfony/Component/HttpKernel/Tests/EventListener/ExceptionListenerTest.php b/src/Symfony/Component/HttpKernel/Tests/EventListener/ExceptionListenerTest.php
@@ -96,8 +96,8 @@ public function provider()
 
         $request = new Request();
         $exception = new \Exception('foo');
-        $event = new GetResponseForExceptionEvent(new TestKernel(), $request, 'foo', $exception);
-        $event2 = new GetResponseForExceptionEvent(new TestKernelThatThrowsException(), $request, 'foo', $exception);
+        $event = new GetResponseForExceptionEvent(new TestKernel(), $request, HttpKernelInterface::MASTER_REQUEST, $exception);
+        $event2 = new GetResponseForExceptionEvent(new TestKernelThatThrowsException(), $request, HttpKernelInterface::MASTER_REQUEST, $exception);
 
         return array(
             array($event, $event2),
@@ -116,7 +116,7 @@ public function testSubRequestFormat()
         $request = Request::create('/');
         $request->setRequestFormat('xml');
 
-        $event = new GetResponseForExceptionEvent($kernel, $request, 'foo', new \Exception('foo'));
+        $event = new GetResponseForExceptionEvent($kernel, $request, HttpKernelInterface::MASTER_REQUEST, new \Exception('foo'));
         $listener->onKernelException($event);
 
         $response = $event->getResponse();
diff --git a/src/Symfony/Component/Routing/Tests/CompiledRouteTest.php b/src/Symfony/Component/Routing/Tests/CompiledRouteTest.php
@@ -18,7 +18,7 @@ class CompiledRouteTest extends TestCase
 {
     public function testAccessors()
     {
-        $compiled = new CompiledRoute('prefix', 'regex', array('tokens'), array(), array(), array(), array(), array('variables'));
+        $compiled = new CompiledRoute('prefix', 'regex', array('tokens'), array(), null, array(), array(), array('variables'));
         $this->assertEquals('prefix', $compiled->getStaticPrefix(), '__construct() takes a static prefix as its second argument');
         $this->assertEquals('regex', $compiled->getRegex(), '__construct() takes a regexp as its third argument');
         $this->assertEquals(array('tokens'), $compiled->getTokens(), '__construct() takes an array of tokens as its fourth argument');
diff --git a/src/Symfony/Component/Security/Http/Authentication/DefaultAuthenticationFailureHandler.php b/src/Symfony/Component/Security/Http/Authentication/DefaultAuthenticationFailureHandler.php
@@ -41,12 +41,6 @@ class DefaultAuthenticationFailureHandler implements AuthenticationFailureHandle
         'failure_path_parameter' => '_failure_path',
     );
 
-    /**
-     * @param HttpKernelInterface $httpKernel
-     * @param HttpUtils           $httpUtils
-     * @param array               $options    Options for processing a failed authentication attempt
-     * @param LoggerInterface     $logger     Optional logger
-     */
     public function __construct(HttpKernelInterface $httpKernel, HttpUtils $httpUtils, array $options = array(), LoggerInterface $logger = null)
     {
         $this->httpKernel = $httpKernel;
diff --git a/src/Symfony/Component/Serializer/Mapping/ClassMetadata.php b/src/Symfony/Component/Serializer/Mapping/ClassMetadata.php
@@ -19,8 +19,6 @@
 class ClassMetadata implements ClassMetadataInterface
 {
     /**
-     * @var string
-     *
      * @internal This property is public in order to reduce the size of the
      *           class' serialized representation. Do not access it. Use
      *           {@link getName()} instead.
diff --git a/src/Symfony/Component/Serializer/Normalizer/GetSetMethodNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/GetSetMethodNormalizer.php
@@ -162,8 +162,6 @@ private function supports($class)
     /**
      * Checks if a method's name is get.* or is.*, and can be called without parameters.
      *
-     * @param \ReflectionMethod $method the method to check
-     *
      * @return bool whether the method is a getter or boolean getter
      */
     private function isGetMethod(\ReflectionMethod $method)
diff --git a/src/Symfony/Component/Templating/Loader/FilesystemLoader.php b/src/Symfony/Component/Templating/Loader/FilesystemLoader.php
@@ -25,7 +25,7 @@ class FilesystemLoader extends Loader
     protected $templatePathPatterns;
 
     /**
-     * @param array $templatePathPatterns An array of path patterns to look for templates
+     * @param string|string[] $templatePathPatterns An array of path patterns to look for templates
      */
     public function __construct($templatePathPatterns)
     {
diff --git a/src/Symfony/Component/Translation/Tests/Writer/TranslationWriterTest.php b/src/Symfony/Component/Translation/Tests/Writer/TranslationWriterTest.php
@@ -27,7 +27,7 @@ public function testWriteTranslations()
 
         $writer = new TranslationWriter();
         $writer->addDumper('test', $dumper);
-        $writer->writeTranslations(new MessageCatalogue(array()), 'test');
+        $writer->writeTranslations(new MessageCatalogue('en'), 'test');
     }
 
     public function testDisableBackup()
diff --git a/src/Symfony/Component/Validator/Tests/Constraints/FileTest.php b/src/Symfony/Component/Validator/Tests/Constraints/FileTest.php
@@ -18,9 +18,6 @@
 class FileTest extends TestCase
 {
     /**
-     * @param mixed $maxSize
-     * @param int   $bytes
-     * @param bool  $binaryFormat
      * @dataProvider provideValidSizes
      */
     public function testMaxSize($maxSize, $bytes, $binaryFormat)
@@ -33,10 +30,6 @@ public function testMaxSize($maxSize, $bytes, $binaryFormat)
 
     /**
      * @dataProvider provideValidSizes
-     *
-     * @param int|string $maxSize
-     * @param int        $bytes
-     * @param string     $binaryFormat
      */
     public function testMaxSizeCanBeSetAfterInitialization($maxSize, $bytes, $binaryFormat)
     {
@@ -50,8 +43,6 @@ public function testMaxSizeCanBeSetAfterInitialization($maxSize, $bytes, $binary
     /**
      * @dataProvider provideInvalidSizes
      * @expectedException \Symfony\Component\Validator\Exception\ConstraintDefinitionException
-     *
-     * @param int|string $maxSize
      */
     public function testInvalidValueForMaxSizeThrowsExceptionAfterInitialization($maxSize)
     {
@@ -61,8 +52,6 @@ public function testInvalidValueForMaxSizeThrowsExceptionAfterInitialization($ma
 
     /**
      * @dataProvider provideInvalidSizes
-     *
-     * @param int|string $maxSize
      */
     public function testMaxSizeCannotBeSetToInvalidValueAfterInitialization($maxSize)
     {
@@ -77,7 +66,6 @@ public function testMaxSizeCannotBeSetToInvalidValueAfterInitialization($maxSize
     }
 
     /**
-     * @param mixed $maxSize
      * @dataProvider provideInValidSizes
      * @expectedException \Symfony\Component\Validator\Exception\ConstraintDefinitionException
      */
@@ -86,9 +74,6 @@ public function testInvalideMaxSize($maxSize)
         $file = new File(array('maxSize' => $maxSize));
     }
 
-    /**
-     * @return array
-     */
     public function provideValidSizes()
     {
         return array(
@@ -105,9 +90,6 @@ public function provideValidSizes()
         );
     }
 
-    /**
-     * @return array
-     */
     public function provideInvalidSizes()
     {
         return array(
@@ -121,9 +103,6 @@ public function provideInvalidSizes()
     }
 
     /**
-     * @param mixed $maxSize
-     * @param bool  $guessedFormat
-     * @param bool  $binaryFormat
      * @dataProvider provideFormats
      */
     public function testBinaryFormat($maxSize, $guessedFormat, $binaryFormat)
@@ -133,9 +112,6 @@ public function testBinaryFormat($maxSize, $guessedFormat, $binaryFormat)
         $this->assertSame($binaryFormat, $file->binaryFormat);
     }
 
-    /**
-     * @return array
-     */
     public function provideFormats()
     {
         return array(
diff --git a/src/Symfony/Component/VarDumper/Cloner/Data.php b/src/Symfony/Component/VarDumper/Cloner/Data.php
@@ -22,7 +22,7 @@ class Data
     private $useRefHandles = -1;
 
     /**
-     * @param array $data A array as returned by ClonerInterface::cloneVar()
+     * @param array $data An array as returned by ClonerInterface::cloneVar()
      */
     public function __construct(array $data)
     {

Original file line number	Diff line number	Diff line change
`@@ -419,8 +419,6 @@ private function fillNextRows(array $rows, $line)`
`419`	`419`	`/**`
`420`	`420`	`* fill cells for a row that contains colspan > 1.`
`421`	`421`	`*`
`422`		`- * @param array\|\Traversable $row`
`423`		`- *`
`424`	`422`	`* @return array`
`425`	`423`	`*/`
`426`	`424`	`private function fillCells($row)`
Original file line number	Diff line number	Diff line change
`@@ -54,8 +54,6 @@ class GraphvizDumper extends Dumper`
`54`	`54`	`* * node.definition: The default options for services that are defined via service definition instances`
`55`	`55`	`* * node.missing: The default options for missing services`
`56`	`56`	`*`
`57`		`- * @param array $options An array of options`
`58`		`- *`
`59`	`57`	`* @return string The dot representation of the service container`
`60`	`58`	`*/`
`61`	`59`	`public function dump(array $options = array())`
Original file line number	Diff line number	Diff line change
`@@ -36,11 +36,6 @@ public function __construct($name)`
`36`	`36`	`$this->name = $name;`
`37`	`37`	`}`
`38`	`38`
`39`		`- /**`
`40`		`- * Converts the object to a string.`
`41`		`- *`
`42`		`- * @return string`
`43`		`- */`
`44`	`39`	`public function __toString()`
`45`	`40`	`{`
`46`	`41`	`return $this->name;`
Original file line number	Diff line number	Diff line change
`@@ -838,9 +838,6 @@ public function testMakePathRelative($endPath, $startPath, $expectedPath)`
`838`	`838`	`$this->assertEquals($expectedPath, $path);`
`839`	`839`	`}`
`840`	`840`
`841`		`- /**`
`842`		`- * @return array`
`843`		`- */`
`844`	`841`	`public function providePathsForMakePathRelative()`
`845`	`842`	`{`
`846`	`843`	`$paths = array(`
`@@ -1078,9 +1075,6 @@ public function testIsAbsolutePath($path, $expectedResult)`
`1078`	`1075`	`$this->assertEquals($expectedResult, $result);`
`1079`	`1076`	`}`
`1080`	`1077`
`1081`		`- /**`
`1082`		`- * @return array`
`1083`		`- */`
`1084`	`1078`	`public function providePathsForIsAbsolutePath()`
`1085`	`1079`	`{`
`1086`	`1080`	`return array(`
Original file line number	Diff line number	Diff line change
`@@ -41,8 +41,6 @@ protected function setUp()`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`/**`
`44`		`- * @param $path`
`45`		`- *`
`46`	`44`	`* @return \PHPUnit_Framework_MockObject_MockObject`
`47`	`45`	`*/`
`48`	`46`	`private function getPropertyPath($path)`