8000 minor #24857 [2.7] More docblock fixes (nicolas-grekas) · symfony/symfony@1e0f226 · GitHub
[go: up one dir, main page]
Skip to content

Commit 1e0f226

Browse files
nicolas-grekasnicolas-grekas
committed
minor #24857 [2.7] More docblock fixes (nicolas-grekas)
This PR was merged into the 2.7 branch. Discussion ---------- [2.7] More docblock fixes | Q | A | ------------- | --- | Branch? | 2.7 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - Commits ------- ac671ac [2.7] More docblock fixes
2 parents 4371d03 + ac671ac commit 1e0f226

File tree

21 files changed

+8
-88
lines changed

21 files changed

+8
-88
lines changed

‎src/Symfony/Component/BrowserKit/Cookie.php

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,6 @@ public function __construct($name, $value, $expires = null, $path = null, $domai
8080

8181
/**
8282
* Returns the HTTP representation of the Cookie.
83-
*
84-
* @return string The HTTP representation of the Cookie
85-
*
86-
* @throws \UnexpectedValueException
8783
*/
8884
public function __toString()
8985
{

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -419,8 +419,6 @@ private function fillNextRows(array $rows, $line)
419419
/**
420420
* fill cells for a row that contains colspan > 1.
421421
*
422-
* @param array|\Traversable $row
423-
*
424422
* @return array
425423
*/
426424
private function fillCells($row)

‎src/Symfony/Component/DependencyInjection/Dumper/GraphvizDumper.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,6 @@ class GraphvizDumper extends Dumper
5454
* * node.definition: The default options for services that are defined via service definition instances
5555
* * node.missing: The default options for missing services
5656
*
57-
* @param array $options An array of options
58-
*
5957
* @return string The dot representation of the service container
6058
*/
6159
public function dump(array $options = array())

‎src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ class PhpDumper extends Dumper
6262
private $expressionLanguageProviders = array();
6363

6464
/**
65-
* @var \Symfony\Component\DependencyInjection\LazyProxy\PhpDumper\DumperInterface
65+
* @var ProxyDumper
6666
*/
6767
private $proxyDumper;
6868

‎src/Symfony/Component/DependencyInjection/Variable.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,6 @@ public function __construct($name)
3636
$this->name = $name;
3737
}
3838

39-
/**
40-
* Converts the object to a string.
41-
*
42-
* @return string
43-
*/
4439
public function __toString()
4540
{
4641
return $this->name;

‎src/Symfony/Component/Filesystem/Tests/FilesystemTest.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -838,9 +838,6 @@ public function testMakePathRelative($endPath, $startPath, $expectedPath)
838838
$this->assertEquals($expectedPath, $path);
839839
}
840840

841-
/**
842-
* @return array
843-
*/
844841
public function providePathsForMakePathRelative()
845842
{
846843
$paths = array(
@@ -1078,9 +1075,6 @@ public function testIsAbsolutePath($path, $expectedResult)
10781075
$this->assertEquals($expectedResult, $result);
10791076
}
10801077

1081-
/**
1082-
* @return array
1083-
*/
10841078
public function providePathsForIsAbsolutePath()
10851079
{
10861080
return array(

‎src/Symfony/Component/Form/Extension/Core/Type/ChoiceType.php

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -444,10 +444,6 @@ public function getName()
444444

445445
/**
446446
* Adds the sub fields for an expanded choice field.
447-
*
448-
* @param FormBuilderInterface $builder The form builder
449-
* @param array $choiceViews The choice view objects
450-
* @param array $options The build options
451447
*/
452448
private function addSubForms(FormBuilderInterface $builder, array $choiceViews, array $options)
453449
{
@@ -468,11 +464,6 @@ private function addSubForms(FormBuilderInterface $builder, array $choiceViews,
468464
}
469465

470466
/**
471-
* @param FormBuilderInterface $builder
472-
* @param $name
473-
* @param $choiceView
474-
* @param array $options
475-
*
476467
* @return mixed
477468
*/
478469
private function addSubForm(FormBuilderInterface $builder, $name, ChoiceView $choiceView, array $options)

‎src/Symfony/Component/Form/FormEvent.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,6 @@ class FormEvent extends Event
2121
private $form;
2222
protected $data;
2323

24-
/**
25-
* Constructs an event.
26-
*
27-
* @param FormInterface $form The associated form
28-
* @param mixed $data The data
29-
*/
3024
public function __construct(FormInterface $form, $data)
3125
{
3226
$this->form = $form;

‎src/Symfony/Component/Form/Tests/Extension/Core/DataMapper/PropertyPathMapperTest.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,6 @@ protected function setUp()
4141
}
4242

4343
/**
44-
* @param $path
45-
*
4644
* @return \PHPUnit_Framework_MockObject_MockObject
4745
*/
4846
private function getPropertyPath($path)

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@
1919
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
2020

2121
/**
22-
* RequestDataCollector.
23-
*
2422
* @author Fabien Potencier <fabien@symfony.com>
2523
*/
2624
class RequestDataCollector extends DataCollector implements EventSubscriberInterface

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

Lines changed: 0 additions & 3 deletions
< 179B /div>
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,6 @@
2727
*/
2828
class FilterControllerEvent extends KernelEvent
2929
{
30-
/**
31-
* The current controller.
32-
*/
3330
private $controller;
3431

3532
public function __construct(HttpKernelInterface $kernel, $controller, Request $request, $requestType)

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

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,11 +67,6 @@ class HttpCache implements HttpKernelInterface, TerminableInterface
6767
* the cache can serve a stale response when an error is encountered (default: 60).
6868
* This setting is overridden by the stale-if-error HTTP Cache-Control extension
6969
* (see RFC 5861).
70-
*
71-
* @param HttpKernelInterface $kernel An HttpKernelInterface instance
72-
* @param StoreInterface $store A Store instance
73-
* @param SurrogateInterface $surrogate A SurrogateInterface instance
74-
* @param array $options An array of options
7570
*/
7671
public function __construct(HttpKernelInterface $kernel, StoreInterface $store, SurrogateInterface $surrogate = null, array $options = array())
7772
{

‎src/Symfony/Component/HttpKernel/Tests/EventListener/ExceptionListenerTest.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,8 @@ public function provider()
9696

9797
$request = new Request();
9898
$exception = new \Exception('foo');
99-
$event = new GetResponseForExceptionEvent(new TestKernel(), $request, 'foo', $exception);
100-
$event2 = new GetResponseForExceptionEvent(new TestKernelThatThrowsException(), $request, 'foo', $exception);
99+
$event = new GetResponseForExceptionEvent(new TestKernel(), $request, HttpKernelInterface::MASTER_REQUEST, $exception);
100+
$event2 = new GetResponseForExceptionEvent(new TestKernelThatThrowsException(), $request, HttpKernelInterface::MASTER_REQUEST, $exception);
101101

102102
return array(
103103
array($event, $event2),
@@ -116,7 +116,7 @@ public function testSubRequestFormat()
116116
$request = Request::create('/');
117117
$request->setRequestFormat('xml');
118118

119-
$event = new GetResponseForExceptionEvent($kernel, $request, 'foo', new \Exception('foo'));
119+
$event = new GetResponseForExceptionEvent($kernel, $request, HttpKernelInterface::MASTER_REQUEST, new \Exception('foo'));
120120
$listener->onKernelException($event);
121121

122122
$response = $event->getResponse();

‎src/Symfony/Component/Routing/Tests/CompiledRouteTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ class CompiledRouteTest extends TestCase
1818
{
1919
public function testAccessors()
2020
{
21-
$compiled = new CompiledRoute('prefix', 'regex', array('tokens'), array(), array(), array(), array(), array('variables'));
21+
$compiled = new CompiledRoute('prefix', 'regex', array('tokens'), array(), null, array(), array(), array('variables'));
2222
$this->assertEquals('prefix', $compiled->getStaticPrefix(), '__construct() takes a static prefix as its second argument');
2323
$this->assertEquals('regex', $compiled->getRegex(), '__construct() takes a regexp as its third argument');
2424
$this->assertEquals(array('tokens'), $compiled->getTokens(), '__construct() takes an array of tokens as its fourth argument');

‎src/Symfony/Component/Security/Http/Authentication/DefaultAuthenticationFailureHandler.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,6 @@ class DefaultAuthenticationFailureHandler implements AuthenticationFailureHandle
4141
'failure_path_parameter' => '_failure_path',
4242
);
4343

44-
/**
45-
* @param HttpKernelInterface $httpKernel
46-
* @param HttpUtils $httpUtils
47-
* @param array $options Options for processing a failed authentication attempt
48-
* @param LoggerInterface $logger Optional logger
49-
*/
5044
public function __construct(HttpKernelInterface $httpKernel, HttpUtils $httpUtils, array $options = array(), LoggerInterface $logger = null)
5145
{
5246
$this->httpKernel = $httpKernel;

‎src/Symfony/Component/Serializer/Mapping/ClassMetadata.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@
1919
class ClassMetadata implements ClassMetadataInterface
2020
{
2121
/**
22-
* @var string
23-
*
2422
* @internal This property is public in order to reduce the size of the
2523
* class' serialized representation. Do not access it. Use
2624
* {@link getName()} instead.

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -162,8 +162,6 @@ private function supports($class)
162162
/**
163163
* Checks if a method's name is get.* or is.*, and can be called without parameters.
164164
*
165-
* @param \ReflectionMethod $method the method to check
166-
*
167165
* @return bool whether the method is a getter or boolean getter
168166
*/
169167
private function isGetMethod(\ReflectionMethod $method)

‎src/Symfony/Component/Templating/Loader/FilesystemLoader.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ class FilesystemLoader extends Loader
2525
protected $templatePathPatterns;
2626

2727
/**
28-
* @param array $templatePathPatterns An array of path patterns to look for templates
28+
* @param string|string[] $templatePathPatterns An array of path patterns to look for templates
2929
*/
3030
public function __construct($templatePathPatterns)
3131
{

‎src/Symfony/Component/Translation/Tests/Writer/TranslationWriterTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ public function testWriteTranslations()
2727

2828
$writer = new TranslationWriter();
2929
$writer->addDumper('test', $dumper);
30-
$writer->writeTranslations(new MessageCatalogue(array()), 'test');
30+
$writer->writeTranslations(new MessageCatalogue('en'), 'test');
3131
}
3232

3333
public function testDisableBackup()

‎src/Symfony/Component/Validator/Tests/Constraints/FileTest.php

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,6 @@
1818
class FileTest extends TestCase
1919
{
2020
/**
21-
* @param mixed $maxSize
22-
* @param int $bytes
23-
* @param bool $binaryFormat
2421
* @dataProvider provideValidSizes
2522
*/
2623
public function testMaxSize($maxSize, $bytes, $binaryFormat)
@@ -33,10 +30,6 @@ public function testMaxSize($maxSize, $bytes, $binaryFormat)
3330

3431
/**
3532
* @dataProvider provideValidSizes
36-
*
37-
* @param int|string $maxSize
38-
* @param int $bytes
39-
* @param string $binaryFormat
4033
*/
4134
public function testMaxSizeCanBeSetAfterInitialization($maxSize, $bytes, $binaryFormat)
4235
{
@@ -50,8 +43,6 @@ public function testMaxSizeCanBeSetAfterInitialization($maxSize, $bytes, $binary
5043
/**
5144
* @dataProvider provideInvalidSizes
5245
* @expectedException \Symfony\Component\Validator\Exception\ConstraintDefinitionException
53-
*
54-
* @param int|string $maxSize
5546
*/
5647
public function testInvalidValueForMaxSizeThrowsExceptionAfterInitialization($maxSize)
5748
{
@@ -61,8 +52,6 @@ public function testInvalidValueForMaxSizeThrowsExceptionAfterInitialization($ma
6152

6253
/**
6354
* @dataProvider provideInvalidSizes
64-
*
65-
* @param int|string $maxSize
6655
*/
6756
public function testMaxSizeCannotBeSetToInvalidValueAfterInitialization($maxSize)
6857
{
@@ -77,7 +66,6 @@ public function testMaxSizeCannotBeSetToInvalidValueAfterInitialization($maxSize
7766
}
7867

7968
/**
80-
* @param mixed $maxSize
8169
* @dataProvider provideInValidSizes
8270
* @expectedException \Symfony\Component\Validator\Exception\ConstraintDefinitionException
8371
*/
@@ -86,9 +74,6 @@ public function testInvalideMaxSize($maxSize)
8674
$file = new File(array('maxSize' => $maxSize));
8775
}
8876

89-
/**
90-
* @return array
91-
*/
9277
public function provideValidSizes()
9378
{
9479
return array(
@@ -105,9 +90,6 @@ public function provideValidSizes()
10590
);
10691
}
10792

108-
/**
109-
* @return array
110-
*/
11193
public function provideInvalidSizes()
11294
{
11395
return array(
@@ -121,9 +103,6 @@ public function provideInvalidSizes()
121103
}
122104

123105
/**
124-
* @param mixed $maxSize
125-
* @param bool $guessedFormat
126-
* @param bool $binaryFormat
127106
* @dataProvider provideFormats
128107
*/
129108
public function testBinaryFormat($maxSize, $guessedFormat, $binaryFormat)
@@ -133,9 +112,6 @@ public function testBinaryFormat($maxSize, $guessedFormat, $binaryFormat)
133112
$this->assertSame($binaryFormat, $file->binaryFormat);
134113
}
135114

136-
/**
137-
* @return array
138-
*/
139115
public function provideFormats()
140116
{
141117
return array(

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ class Data
2222
private $useRefHandles = -1;
2323

2424
/**
25-
* @param array $data A array as returned by ClonerInterface::cloneVar()
25+
* @param array $data An array as returned by ClonerInterface::cloneVar()
2626
*/
2727
public function __construct(array $data)
2828
{

0 commit comments

Comments
 (0)
0