Skip to content

Commit 1b8585c

Browse files
Cleanup more @return annotations
1 parent 0ae4c94 commit 1b8585c

36 files changed

+85
-87
lines changed

Bundle/Bundle.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ public function build(ContainerBuilder $container)
5858
/**
5959
* Returns the bundle's container extension.
6060
*
61-
* @return ExtensionInterface|null The container extension
61+
* @return ExtensionInterface|null
6262
*
6363
* @throws \LogicException
6464
*/

Bundle/BundleInterface.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -42,21 +42,21 @@ public function build(ContainerBuilder $container);
4242
/**
4343
* Returns the container extension that should be implicitly loaded.
4444
*
45-
* @return ExtensionInterface|null The default extension or null if there is none
45+
* @return ExtensionInterface|null
4646
*/
4747
public function getContainerExtension();
4848

4949
/**
5050
* Returns the bundle name (the class short name).
5151
*
52-
* @return string The Bundle name
52+
* @return string
5353
*/
5454
public function getName();
5555

5656
/**
5757
* Gets the Bundle namespace.
5858
*
59-
* @return string The Bundle namespace
59+
* @return string
6060
*/
6161
public function getNamespace();
6262

@@ -65,7 +65,7 @@ public function getNamespace();
6565
*
6666
* The path should always be returned as a Unix path (with /).
6767
*
68-
* @return string The Bundle absolute path
68+
* @return string
6969
*/
7070
public function getPath();
7171
}

CacheWarmer/CacheWarmerAggregate.php

-2
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,6 @@ public function warmUp(string $cacheDir)
115115

116116
/**
117117
* Checks whether this warmer is optional or not.
118-
*
119-
* @return bool always false
120118
*/
121119
public function isOptional(): bool
122120
{

CacheWarmer/CacheWarmerInterface.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ interface CacheWarmerInterface extends WarmableInterface
2626
* A warmer should return true if the cache can be
2727
* generated incrementally and on-demand.
2828
*
29-
* @return bool true if the warmer is optional, false otherwise
29+
* @return bool
3030
*/
3131
public function isOptional();
3232
}

Controller/ArgumentResolverInterface.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ interface ArgumentResolverInterface
2424
/**
2525
* Returns the arguments to pass to the controller.
2626
*
27-
* @return array An array of arguments to pass to the controller
27+
* @return array
2828
*
2929
* @throws \RuntimeException When no value could be provided for a required argument
3030
*/

Controller/ControllerResolver.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ public function getController(Request $request)
9898
/**
9999
* Returns a callable for the given controller.
100100
*
101-
* @return callable A PHP callable
101+
* @return callable
102102
*
103103
* @throws \InvalidArgumentException When the controller cannot be created
104104
*/

DataCollector/ConfigDataCollector.php

+9-9
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ public function lateCollect()
9494
/**
9595
* Gets the token.
9696
*
97-
* @return string|null The token
97+
* @return string|null
9898
*/
9999
public function getToken()
100100
{
@@ -104,7 +104,7 @@ public function getToken()
104104
/**
105105
* Gets the Symfony version.
106106
*
107-
* @return string The Symfony version
107+
* @return string
108108
*/
109109
public function getSymfonyVersion()
110110
{
@@ -165,7 +165,7 @@ public function getSymfonyEol()
165165
/**
166166
* Gets the PHP version.
167167
*
168-
* @return string The PHP version
168+
* @return string
169169
*/
170170
public function getPhpVersion()
171171
{
@@ -175,7 +175,7 @@ public function getPhpVersion()
175175
/**
176176
* Gets the PHP version extra part.
177177
*
178-
* @return string|null The extra part
178+
* @return string|null
179179
*/
180180
public function getPhpVersionExtra()
181181
{
@@ -209,7 +209,7 @@ public function getPhpTimezone()
209209
/**
210210
* Gets the environment.
211211
*
212-
* @return string The environment
212+
* @return string
213213
*/
214214
public function getEnv()
215215
{
@@ -229,7 +229,7 @@ public function isDebug()
229229
/**
230230
* Returns true if the XDebug is enabled.
231231
*
232-
* @return bool true if XDebug is enabled, false otherwise
232+
* @return bool
233233
*/
234234
public function hasXDebug()
235235
{
@@ -239,7 +239,7 @@ public function hasXDebug()
239239
/**
240240
* Returns true if APCu is enabled.
241241
*
242-
* @return bool true if APCu is enabled, false otherwise
242+
* @return bool
243243
*/
244244
public function hasApcu()
245245
{
@@ -249,7 +249,7 @@ public function hasApcu()
249249
/**
250250
* Returns true if Zend OPcache is enabled.
251251
*
252-
* @return bool true if Zend OPcache is enabled, false otherwise
252+
* @return bool
253253
*/
254254
public function hasZendOpcache()
255255
{
@@ -264,7 +264,7 @@ public function getBundles()
264264
/**
265265
* Gets the PHP SAPI name.
266266
*
267-
* @return string The environment
267+
* @return string
268268
*/
269269
public function getSapiName()
270270
{

DataCollector/DataCollectorInterface.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public function collect(Request $request, Response $response, \Throwable $except
3030
/**
3131
* Returns the name of the collector.
3232
*
33-
* @return string The collector name
33+
* @return string
3434
*/
3535
public function getName();
3636
}

DataCollector/EventDataCollector.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ public function setCalledListeners(array $listeners)
8585
/**
8686
* Gets the called listeners.
8787
*
88-
* @return array An array of called listeners
88+
* @return array
8989
*
9090
* @see TraceableEventDispatcher
9191
*/
@@ -131,7 +131,7 @@ public function setOrphanedEvents(array $events)
131131
/**
132132
* Gets the orphaned events.
133133
*
134-
* @return array An array of orphaned events
134+
* @return array
135135
*
136136
* @see TraceableEventDispatcher
137137
*/

DataCollector/ExceptionDataCollector.php

+5-5
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ public function reset()
4747
/**
4848
* Checks if the exception is not null.
4949
*
50-
* @return bool true if the exception is not null, false otherwise
50+
* @return bool
5151
*/
5252
public function hasException()
5353
{
@@ -67,7 +67,7 @@ public function getException()
6767
/**
6868
* Gets the exception message.
6969
*
70-
* @return string The exception message
70+
* @return string
7171
*/
7272
public function getMessage()
7373
{
@@ -77,7 +77,7 @@ public function getMessage()
7777
/**
7878
* Gets the exception code.
7979
*
80-
* @return int The exception code
80+
* @return int
8181
*/
8282
public function getCode()
8383
{
@@ -87,7 +87,7 @@ public function getCode()
8787
/**
8888
* Gets the status code.
8989
*
90-
* @return int The status code
90+
* @return int
9191
*/
9292
public function getStatusCode()
9393
{
@@ -97,7 +97,7 @@ public function getStatusCode()
9797
/**
9898
* Gets the exception trace.
9999
*
100-
* @return array The exception trace
100+
* @return array
101101
*/
102102
public function getTrace()
103103
{

DataCollector/MemoryDataCollector.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ public function lateCollect()
5858
/**
5959
* Gets the memory.
6060
*
61-
* @return int The memory
61+
* @return int
6262
*/
6363
public function getMemory()
6464
{
@@ -68,7 +68,7 @@ public function getMemory()
6868
/**
6969
* Gets the PHP memory limit.
7070
*
71-
* @return int The memory limit
71+
* @return int
7272
*/
7373
public function getMemoryLimit()
7474
{

DataCollector/RequestDataCollector.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ public function getDotenvVars()
317317
*
318318
* The _route request attributes is automatically set by the Router Matcher.
319319
*
320-
* @return string The route
320+
* @return string
321321
*/
322322
public function getRoute()
323323
{
@@ -334,7 +334,7 @@ public function getIdentifier()
334334
*
335335
* The _route_params request attributes is automatically set by the RouterListener.
336336
*
337-
* @return array The parameters
337+
* @return array
338338
*/
339339
public function getRouteParams()
340340
{

DataCollector/RouterDataCollector.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -83,15 +83,15 @@ public function getRedirect()
8383
}
8484

8585
/**
86-
* @return string|null The target URL
86+
* @return string|null
8787
*/
8888
public function getTargetUrl()
8989
{
9090
return $this->data['url'];
9191
}
9292

9393
/**
94-
* @return string|null The target route
94+
* @return string|null
9595
*/
9696
public function getTargetRoute()
9797
{

DataCollector/TimeDataCollector.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ public function setEvents(array $events)
9292
/**
9393
* Gets the request events.
9494
*
95-
* @return StopwatchEvent[] The request events
95+
* @return StopwatchEvent[]
9696
*/
9797
public function getEvents()
9898
{
@@ -102,7 +102,7 @@ public function getEvents()
102102
/**
103103
* Gets the request elapsed time.
104104
*
105-
* @return float The elapsed time
105+
* @return float
106106
*/
107107
public function getDuration()
108108
{
@@ -120,7 +120,7 @@ public function getDuration()
120120
*
121121
* This is the time spent until the beginning of the request handling.
122122
*
123-
* @return float The elapsed time
123+
* @return float
124124
*/
125125
public function getInitTime()
126126
{
@@ -142,7 +142,7 @@ public function getStartTime()
142142
}
143143

144144
/**
145-
* @return bool whether or not the stopwatch component is installed
145+
* @return bool
146146
*/
147147
public function isStopwatchInstalled()
148148
{

DependencyInjection/Extension.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ abstract class Extension extends BaseExtension
2525
/**
2626
* Gets the annotated classes to cache.
2727
*
28-
* @return array An array of classes
28+
* @return array
2929
*/
3030
public function getAnnotatedClassesToCompile()
3131
{

Event/KernelEvent.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ public function isMainRequest(): bool
7979
/**
8080
* Checks if this is a master request.
8181
*
82-
* @return bool True if the request is a master request
82+
* @return bool
8383
*
8484
* @deprecated since symfony/http-kernel 5.3, use isMainRequest() instead
8585
*/

Event/RequestEvent.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public function setResponse(Response $response)
4949
/**
5050
* Returns whether a response was set.
5151
*
52-
* @return bool Whether a response was set
52+
* @return bool
5353
*/
5454
public function hasResponse()
5555
{

Event/ViewEvent.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ public function __construct(HttpKernelInterface $kernel, Request $request, int $
4242
/**
4343
* Returns the return value of the controller.
4444
*
45-
* @return mixed The controller return value
45+
* @return mixed
4646
*/
4747
public function getControllerResult()
4848
{

Exception/HttpExceptionInterface.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@ interface HttpExceptionInterface extends \Throwable
2121
/**
2222
* Returns the status code.
2323
*
24-
* @return int An HTTP response status code
24+
* @return int
2525
*/
2626
public function getStatusCode();
2727

2828
/**
2929
* Returns response headers.
3030
*
31-
* @return array Response headers
31+
* @return array
3232
*/
3333
public function getHeaders();
3434
}

Fragment/FragmentHandler.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public function addRenderer(FragmentRendererInterface $renderer)
6363
*
6464
* @param string|ControllerReference $uri A URI as a string or a ControllerReference instance
6565
*
66-
* @return string|null The Response content or null when the Response is streamed
66+
* @return string|null
6767
*
6868
* @throws \InvalidArgumentException when the renderer does not exist
6969
* @throws \LogicException when no main request is being handled

Fragment/FragmentRendererInterface.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public function render($uri, Request $request, array $options = []);
3434
/**
3535
* Gets the name of the strategy.
3636
*
37-
* @return string The strategy name
37+
* @return string
3838
*/
3939
public function getName();
4040
}

0 commit comments

Comments
 (0)