Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 646d9b0

Browse filesBrowse files
derrabusderrabus
committed
minor #42495 Cleanup @return annotations (nicolas-grekas)
This PR was merged into the 5.4 branch. Discussion ---------- Cleanup ``@return`` annotations | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - The goal of this patch is to allow php-cs-fixer to remove these annotations on 6.0 when native return types will be used. Commits ------- 8efde8f Cleanup ``@return`` annotations
2 parents 488a46f + 8efde8f commit 646d9b0
Copy full SHA for 646d9b0

File tree

Expand file treeCollapse file tree

92 files changed

+166
-190
lines changed
Filter options

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Dismiss banner
Expand file treeCollapse file tree

92 files changed

+166
-190
lines changed

‎src/Symfony/Bundle/FrameworkBundle/Console/Application.php

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/FrameworkBundle/Console/Application.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ public function __construct(KernelInterface $kernel)
4747
/**
4848
* Gets the Kernel associated with this Console.
4949
*
50-
* @return KernelInterface A KernelInterface instance
50+
* @return KernelInterface
5151
*/
5252
public function getKernel()
5353
{

‎src/Symfony/Bundle/FrameworkBundle/KernelBrowser.php

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/FrameworkBundle/KernelBrowser.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ public function getKernel()
6767
/**
6868
* Gets the profile associated with the current Response.
6969
*
70-
* @return HttpProfile|false|null A Profile instance
70+
* @return HttpProfile|false|null
7171
*/
7272
public function getProfile()
7373
{

‎src/Symfony/Bundle/FrameworkBundle/Test/KernelTestCase.php

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/FrameworkBundle/Test/KernelTestCase.php
+2-2Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ protected static function getKernelClass()
7373
/**
7474
* Boots the Kernel for this test.
7575
*
76-
* @return KernelInterface A KernelInterface instance
76+
* @return KernelInterface
7777
*/
7878
protected static function bootKernel(array $options = [])
7979
{
@@ -118,7 +118,7 @@ protected static function getContainer(): ContainerInterface
118118
* * environment
119119
* * debug
120120
*
121-
* @return KernelInterface A KernelInterface instance
121+
* @return KernelInterface
122122
*/
123123
protected static function createKernel(array $options = [])
124124
{

‎src/Symfony/Bundle/FrameworkBundle/Test/WebTestCase.php

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/FrameworkBundle/Test/WebTestCase.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ protected function tearDown(): void
3535
* @param array $options An array of options to pass to the createKernel method
3636
* @param array $server An array of server parameters
3737
*
38-
* @return KernelBrowser A KernelBrowser instance
38+
* @return KernelBrowser
3939
*/
4040
protected static function createClient(array $options = [], array $server = [])
4141
{

‎src/Symfony/Bundle/WebProfilerBundle/Controller/ProfilerController.php

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/WebProfilerBundle/Controller/ProfilerController.php
+8-8Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ public function __construct(UrlGeneratorInterface $generator, Profiler $profiler
5252
/**
5353
* Redirects to the last profiles.
5454
*
55-
* @return RedirectResponse A RedirectResponse instance
55+
* @return RedirectResponse
5656
*
5757
* @throws NotFoundHttpException
5858
*/
@@ -66,7 +66,7 @@ public function homeAction()
6666
/**
6767
* Renders a profiler panel for the given token.
6868
*
69-
* @return Response A Response instance
69+
* @return Response
7070
*
7171
* @throws NotFoundHttpException
7272
*/
@@ -125,7 +125,7 @@ public function panelAction(Request $request, string $token)
125125
/**
126126
* Renders the Web Debug Toolbar.
127127
*
128-
* @return Response A Response instance
128+
* @return Response
129129
*
130130
* @throws NotFoundHttpException
131131
*/
@@ -170,7 +170,7 @@ public function toolbarAction(Request $request, string $token = null)
170170
/**
171171
* Renders the profiler search bar.
172172
*
173-
* @return Response A Response instance
173+
* @return Response
174174
*
175175
* @throws NotFoundHttpException
176176
*/
@@ -224,7 +224,7 @@ public function searchBarAction(Request $request)
224224
/**
225225
* Renders the search results.
226226
*
227-
* @return Response A Response instance
227+
* @return Response
228228
*
229229
* @throws NotFoundHttpException
230230
*/
@@ -265,7 +265,7 @@ public function searchResultsAction(Request $request, string $token)
265265
/**
266266
* Narrows the search bar.
267267
*
268-
* @return Response A Response instance
268+
* @return Response
269269
*
270270
* @throws NotFoundHttpException
271271
*/
@@ -316,7 +316,7 @@ public function searchAction(Request $request)
316316
/**
317317
* Displays the PHP info.
318318
*
319-
* @return Response A Response instance
319+
* @return Response
320320
*
321321
* @throws NotFoundHttpException
322322
*/
@@ -338,7 +338,7 @@ public function phpinfoAction()
338338
/**
339339
* Displays the source of a file.
340340
*
341-
* @return Response A Response instance
341+
* @return Response
342342
*
343343
* @throws NotFoundHttpException
344344
*/

‎src/Symfony/Bundle/WebProfilerBundle/Controller/RouterController.php

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/WebProfilerBundle/Controller/RouterController.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ public function __construct(Profiler $profiler = null, Environment $twig, UrlMat
5454
/**
5555
* Renders the profiler panel for the given token.
5656
*
57-
* @return Response A Response instance
57+
* @return Response
5858
*
5959
* @throws NotFoundHttpException
6060
*/

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

Copy file name to clipboardExpand all lines: src/Symfony/Component/BrowserKit/AbstractBrowser.php
+12-24Lines changed: 12 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -105,8 +105,6 @@ public function getMaxRedirects()
105105
/**
106106
* Sets the insulated flag.
107107
*
108-
* @param bool $insulated Whether to insulate the requests or not
109-
*
110108
* @throws \RuntimeException When Symfony Process Component is not installed
111109
*/
112110
public function insulate(bool $insulated = true)
@@ -120,8 +118,6 @@ public function insulate(bool $insulated = true)
120118

121119
/**
122120
* Sets server parameters.
123-
*
124-
* @param array $server An array of server parameters
125121
*/
126122
public function setServerParameters(array $server)
127123
{
@@ -143,7 +139,7 @@ public function setServerParameter(string $key, string $value)
143139
*
144140
* @param mixed $default A default value when key is undefined
145141
*
146-
* @return mixed A value of the parameter
142+
* @return mixed
147143
*/
148144
public function getServerParameter(string $key, $default = '')
149145
{
@@ -182,7 +178,7 @@ public function jsonRequest(string $method, string $uri, array $parameters = [],
182178
/**
183179
* Returns the History instance.
184180
*
185-
* @return History A History instance
181+
* @return History
186182
*/
187183
public function getHistory()
188184
{
@@ -192,7 +188,7 @@ public function getHistory()
192188
/**
193189
* Returns the CookieJar instance.
194190
*
195-
* @return CookieJar A CookieJar instance
191+
* @return CookieJar
196192
*/
197193
public function getCookieJar()
198194
{
@@ -202,7 +198,7 @@ public function getCookieJar()
202198
/**
203199
* Returns the current Crawler instance.
204200
*
205-
* @return Crawler A Crawler instance
201+
* @return Crawler
206202
*/
207203
public function getCrawler()
208204
{
@@ -216,7 +212,7 @@ public function getCrawler()
216212
/**
217213
* Returns the current BrowserKit Response instance.
218214
*
219-
* @return Response A BrowserKit Response instance
215+
* @return Response
220216
*/
221217
public function getInternalResponse()
222218
{
@@ -233,7 +229,7 @@ public function getInternalResponse()
233229
* The origin response is the response instance that is returned
234230
* by the code that handles requests.
235231
*
236-
* @return object A response instance
232+
* @return object
237233
*
238234
* @see doRequest()
239235
*/
@@ -249,7 +245,7 @@ public function getResponse()
249245
/**
250246
* Returns the current BrowserKit Request instance.
251247
*
252-
* @return Request A BrowserKit Request instance
248+
* @return Request
253249
*/
254250
public function getInternalRequest()
255251
{
@@ -266,7 +262,7 @@ public function getInternalRequest()
266262
* The origin request is the request instance that is sent
267263
* to the code that handles requests.
268264
*
269-
* @return object A Request instance
265+
* @return object
270266
*
271267
* @see doRequest()
272268
*/
@@ -435,9 +431,7 @@ public function request(string $method, string $uri, array $parameters = [], arr
435431
/**
436432
* Makes a request in another process.
437433
*
438-
* @param object $request An origin request instance
439-
*
440-
* @return object An origin response instance
434+
* @return object
441435
*
442436
* @throws \RuntimeException When processing returns exit code
443437
*/
@@ -472,9 +466,7 @@ protected function doRequestInProcess(object $request)
472466
/**
473467
* Makes a request.
474468
*
475-
* @param object $request An origin request instance
476-
*
477-
* @return object An origin response instance
469+
* @return object
478470
*/
479471
abstract protected function doRequest(object $request);
480472

@@ -493,7 +485,7 @@ protected function getScript(object $request)
493485
/**
494486
* Filters the BrowserKit request to the origin one.
495487
*
496-
* @return object An origin request instance
488+
* @return object
497489
*/
498490
protected function filterRequest(Request $request)
499491
{
@@ -503,9 +495,7 @@ protected function filterRequest(Request $request)
503495
/**
504496
* Filters the origin response to the BrowserKit one.
505497
*
506-
* @param object $response The origin response to filter
507-
*
508-
* @return Response An BrowserKit Response instance
498+
* @return Response
509499
*/
510500
protected function filterResponse(object $response)
511501
{
@@ -649,8 +639,6 @@ public function restart()
649639
/**
650640
* Takes a URI and converts it to absolute if it is not already absolute.
651641
*
652-
* @param string $uri A URI
653-
*
654642
* @return string An absolute URI
655643
*/
656644
protected function getAbsoluteUri(string $uri)

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

Copy file name to clipboardExpand all lines: src/Symfony/Component/BrowserKit/CookieJar.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public function set(Cookie $cookie)
3333
* (this behavior ensures a BC behavior with previous versions of
3434
* Symfony).
3535
*
36-
* @return Cookie|null A Cookie instance or null if the cookie does not exist
36+
* @return Cookie|null
3737
*/
3838
public function get(string $name, string $path = '/', string $domain = null)
3939
{

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

Copy file name to clipboardExpand all lines: src/Symfony/Component/BrowserKit/History.php
+3-3Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public function isEmpty()
5353
/**
5454
* Goes back in the history.
5555
*
56-
* @return Request A Request instance
56+
* @return Request
5757
*
5858
* @throws \LogicException if the stack is already on the first page
5959
*/
@@ -69,7 +69,7 @@ public function back()
6969
/**
7070
* Goes forward in the history.
7171
*
72-
* @return Request A Request instance
72+
* @return Request
7373
*
7474
* @throws \LogicException if the stack is already on the last page
7575
*/
@@ -85,7 +85,7 @@ public function forward()
8585
/**
8686
* Returns the current element in the history.
8787
*
88-
* @return Request A Request instance
88+
* @return Request
8989
*
9090
* @throws \LogicException if the stack is empty
9191
*/

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

Copy file name to clipboardExpand all lines: src/Symfony/Component/Cache/Adapter/PdoAdapter.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ class PdoAdapter extends AbstractAdapter implements PruneableInterface
6060
* * db_password: The password when lazy-connect [default: '']
6161
* * db_connection_options: An array of driver-specific connection options [default: []]
6262
*
63-
* @param \PDO|Connection|string $connOrDsn a \PDO or Connection instance or DSN string or null
63+
* @param \PDO|Connection|string $connOrDsn
6464
*
6565
* @throws InvalidArgumentException When first argument is not PDO nor Connection nor string
6666
* @throws InvalidArgumentException When PDO error mode is not PDO::ERRMODE_EXCEPTION

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

Copy file name to clipboardExpand all lines: src/Symfony/Component/Config/ConfigCacheFactoryInterface.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ interface ConfigCacheFactoryInterface
2626
* @param string $file The absolute cache file path
2727
* @param callable $callable The callable to be executed when the cache needs to be filled (i. e. is not fresh). The cache will be passed as the only parameter to this callback
2828
*
29-
* @return ConfigCacheInterface The cache instance
29+
* @return ConfigCacheInterface
3030
*/
3131
public function cache(string $file, callable $callable);
3232
}

‎src/Symfony/Component/Config/Definition/Builder/NodeDefinition.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Config/Definition/Builder/NodeDefinition.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -357,7 +357,7 @@ protected function normalization()
357357
/**
358358
* Instantiate and configure the node according to this definition.
359359
*
360-
* @return NodeInterface The node instance
360+
* @return NodeInterface
361361
*
362362
* @throws InvalidDefinitionException When the definition is invalid
363363
*/

‎src/Symfony/Component/Config/Definition/PrototypedArrayNode.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Config/Definition/PrototypedArrayNode.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,7 @@ protected function mergeValues($leftSide, $rightSide)
338338
* Now, the key becomes 'name001' and the child node becomes 'value001' and
339339
* the prototype of child node 'name001' should be a ScalarNode instead of an ArrayNode instance.
340340
*
341-
* @return mixed The prototype instance
341+
* @return mixed
342342
*/
343343
private function getPrototypeForChild(string $key)
344344
{

‎src/Symfony/Component/Config/Loader/LoaderInterface.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Config/Loader/LoaderInterface.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public function supports($resource, string $type = null);
4141
/**
4242
* Gets the loader resolver.
4343
*
44-
* @return LoaderResolverInterface A LoaderResolverInterface instance
44+
* @return LoaderResolverInterface
4545
*/
4646
public function getResolver();
4747

‎src/Symfony/Component/Config/Loader/LoaderResolver.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Config/Loader/LoaderResolver.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ public function addLoader(LoaderInterface $loader)
5959
/**
6060
* Returns the registered loaders.
6161
*
62-
* @return LoaderInterface[] An array of LoaderInterface instances
62+
* @return LoaderInterface[]
6363
*/
6464
public function getLoaders()
6565
{

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.