Skip to content

Commit 9a55ba3

Browse files
nicolas-grekasnicolas-grekas
committed
Cleanup more @return annotations
1 parent 44a2644 commit 9a55ba3

17 files changed

+58
-56
lines changed

‎CompiledRoute.php

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ final public function unserialize($serialized)
9494
/**
9595
* Returns the static prefix.
9696
*
97-
* @return string The static prefix
97+
* @return string
9898
*/
9999
public function getStaticPrefix()
100100
{
@@ -104,7 +104,7 @@ public function getStaticPrefix()
104104
/**
105105
* Returns the regex.
106106
*
107-
* @return string The regex
107+
* @return string
108108
*/
109109
public function getRegex()
110110
{
@@ -114,7 +114,7 @@ public function getRegex()
114114
/**
115115
* Returns the host regex.
116116
*
117-
* @return string|null The host regex or null
117+
* @return string|null
118118
*/
119119
public function getHostRegex()
120120
{
@@ -124,7 +124,7 @@ public function getHostRegex()
124124
/**
125125
* Returns the tokens.
126126
*
127-
* @return array The tokens
127+
* @return array
128128
*/
129129
public function getTokens()
130130
{
@@ -134,7 +134,7 @@ public function getTokens()
134134
/**
135135
* Returns the host tokens.
136136
*
137-
* @return array The tokens
137+
* @return array
138138
*/
139139
public function getHostTokens()
140140
{
@@ -144,7 +144,7 @@ public function getHostTokens()
144144
/**
145145
* Returns the variables.
146146
*
147-
* @return array The variables
147+
* @return array
148148
*/
149149
public function getVariables()
150150
{
@@ -154,7 +154,7 @@ public function getVariables()
154154
/**
155155
* Returns the path variables.
156156
*
157-
* @return array The variables
157+
* @return array
158158
*/
159159
public function getPathVariables()
160160
{
@@ -164,7 +164,7 @@ public function getPathVariables()
164164
/**
165165
* Returns the host variables.
166166
*
167-
* @return array The variables
167+
* @return array
168168
*/
169169
public function getHostVariables()
170170
{

‎Generator/Dumper/GeneratorDumperInterface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ interface GeneratorDumperInterface
2424
* Dumps a set of routes to a string representation of executable code
2525
* that can then be used to generate a URL of such a route.
2626
*
27-
* @return string Executable code
27+
* @return string
2828
*/
2929
public function dump(array $options = []);
3030

‎Generator/UrlGenerator.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,7 @@ protected function doGenerate(array $variables, array $defaults, array $requirem
332332
* @param string $basePath The base path
333333
* @param string $targetPath The target path
334334
*
335-
* @return string The relative target path
335+
* @return string
336336
*/
337337
public static function getRelativePath(string $basePath, string $targetPath)
338338
{

‎Generator/UrlGeneratorInterface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ interface UrlGeneratorInterface extends RequestContextAwareInterface
7171
*
7272
* The special parameter _fragment will be used as the document fragment suffixed to the final URL.
7373
*
74-
* @return string The generated URL
74+
* @return string
7575
*
7676
* @throws RouteNotFoundException If the named route doesn't exist
7777
* @throws MissingMandatoryParametersException When some parameters are missing that are mandatory for the route

‎Loader/AnnotationFileLoader.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ public function supports($resource, string $type = null)
7878
/**
7979
* Returns the full class name for the first class in the file.
8080
*
81-
* @return string|false Full class name if found, false otherwise
81+
* @return string|false
8282
*/
8383
protected function findClass(string $file)
8484
{

‎Loader/XmlFileLoader.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,7 @@ private function parseConfigs(\DOMElement $node, string $path): array
321321
/**
322322
* Parses the "default" elements.
323323
*
324-
* @return array|bool|float|int|string|null The parsed value of the "default" element
324+
* @return array|bool|float|int|string|null
325325
*/
326326
private function parseDefaultsConfig(\DOMElement $element, string $path)
327327
{
@@ -353,7 +353,7 @@ private function parseDefaultsConfig(\DOMElement $element, string $path)
353353
/**
354354
* Recursively parses the value of a "default" element.
355355
*
356-
* @return array|bool|float|int|string|null The parsed value
356+
* @return array|bool|float|int|string|null
357357
*
358358
* @throws \InvalidArgumentException when the XML is invalid
359359
*/

‎Matcher/Dumper/MatcherDumperInterface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ interface MatcherDumperInterface
2424
* Dumps a set of routes to a string representation of executable code
2525
* that can then be used to match a request against these routes.
2626
*
27-
* @return string Executable code
27+
* @return string
2828
*/
2929
public function dump(array $options = []);
3030

‎Matcher/RedirectableUrlMatcherInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@
1919
interface RedirectableUrlMatcherInterface
2020
{
2121
/**
22-
* Redirects the user to another URL.
22+
* Redirects the user to another URL and returns the parameters for the redirection.
2323
*
2424
* @param string $path The path info to redirect to
2525
* @param string $route The route name that matched
2626
* @param string|null $scheme The URL scheme (null to keep the current one)
2727
*
28-
* @return array An array of parameters
28+
* @return array
2929
*/
3030
public function redirect(string $path, string $route, string $scheme = null);
3131
}

‎Matcher/RequestMatcherInterface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ interface RequestMatcherInterface
2929
* If the matcher can not find information, it must throw one of the exceptions documented
3030
* below.
3131
*
32-
* @return array An array of parameters
32+
* @return array
3333
*
3434
* @throws NoConfigurationException If no routing configuration could be found
3535
* @throws ResourceNotFoundException If no matching resource could be found

‎Matcher/UrlMatcher.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ public function addExpressionLanguageProvider(ExpressionFunctionProviderInterfac
120120
*
121121
* @param string $pathinfo The path info to be parsed
122122
*
123-
* @return array An array of parameters
123+
* @return array
124124
*
125125
* @throws NoConfigurationException If no routing configuration could be found
126126
* @throws ResourceNotFoundException If the resource could not be found
@@ -205,7 +205,7 @@ protected function matchCollection(string $pathinfo, RouteCollection $routes)
205205
* in matchers that do not have access to the matched Route instance
206206
* (like the PHP and Apache matcher dumpers).
207207
*
208-
* @return array An array of parameters
208+
* @return array
209209
*/
210210
protected function getAttributes(Route $route, string $name, array $attributes)
211211
{
@@ -237,7 +237,7 @@ protected function handleRouteRequirements(string $pathinfo, string $name, Route
237237
/**
238238
* Get merged default parameters.
239239
*
240-
* @return array Merged default parameters
240+
* @return array
241241
*/
242242
protected function mergeDefaults(array $params, array $defaults)
243243
{

‎Matcher/UrlMatcherInterface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ interface UrlMatcherInterface extends RequestContextAwareInterface
3131
*
3232
* @param string $pathinfo The path info to be parsed (raw format, i.e. not urldecoded)
3333
*
34-
* @return array An array of parameters
34+
* @return array
3535
*
3636
* @throws NoConfigurationException If no routing configuration could be found
3737
* @throws ResourceNotFoundException If the resource could not be found

‎RequestContext.php

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ public function fromRequest(Request $request)
8484
/**
8585
* Gets the base URL.
8686
*
87-
* @return string The base URL
87+
* @return string
8888
*/
8989
public function getBaseUrl()
9090
{
@@ -106,7 +106,7 @@ public function setBaseUrl(string $baseUrl)
106106
/**
107107
* Gets the path info.
108108
*
109-
* @return string The path info
109+
* @return string
110110
*/
111111
public function getPathInfo()
112112
{
@@ -130,7 +130,7 @@ public function setPathInfo(string $pathInfo)
130130
*
131131
* The method is always an uppercased string.
132132
*
133-
* @return string The HTTP method
133+
* @return string
134134
*/
135135
public function getMethod()
136136
{
@@ -154,7 +154,7 @@ public function setMethod(string $method)
154154
*
155155
* The host is always lowercased because it must be treated case-insensitive.
156156
*
157-
* @return string The HTTP host
157+
* @return string
158158
*/
159159
public function getHost()
160160
{
@@ -176,7 +176,7 @@ public function setHost(string $host)
176176
/**
177177
* Gets the HTTP scheme.
178178
*
179-
* @return string The HTTP scheme
179+
* @return string
180180
*/
181181
public function getScheme()
182182
{
@@ -198,7 +198,7 @@ public function setScheme(string $scheme)
198198
/**
199199
* Gets the HTTP port.
200200
*
201-
* @return int The HTTP port
201+
* @return int
202202
*/
203203
public function getHttpPort()
204204
{
@@ -220,7 +220,7 @@ public function setHttpPort(int $httpPort)
220220
/**
221221
* Gets the HTTPS port.
222222
*
223-
* @return int The HTTPS port
223+
* @return int
224224
*/
225225
public function getHttpsPort()
226226
{
@@ -240,9 +240,9 @@ public function setHttpsPort(int $httpsPort)
240240
}
241241

242242
/**
243-
* Gets the query string.
243+
* Gets the query string without the "?".
244244
*
245-
* @return string The query string without the "?"
245+
* @return string
246246
*/
247247
public function getQueryString()
248248
{
@@ -265,7 +265,7 @@ public function setQueryString(?string $queryString)
265265
/**
266266
* Returns the parameters.
267267
*
268-
* @return array The parameters
268+
* @return array
269269
*/
270270
public function getParameters()
271271
{
@@ -289,7 +289,7 @@ public function setParameters(array $parameters)
289289
/**
290290
* Gets a parameter value.
291291
*
292-
* @return mixed The parameter value or null if nonexistent
292+
* @return mixed
293293
*/
294294
public function getParameter(string $name)
295295
{
@@ -299,7 +299,7 @@ public function getParameter(string $name)
299299
/**
300300
* Checks if a parameter value is set for the given parameter.
301301
*
302-
* @return bool True if the parameter value is set, false otherwise
302+
* @return bool
303303
*/
304304
public function hasParameter(string $name)
305305
{

‎RequestContextAwareInterface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public function setContext(RequestContext $context);
2121
/**
2222
* Gets the request context.
2323
*
24-
* @return RequestContext The context
24+
* @return RequestContext
2525
*/
2626
public function getContext();
2727
}

0 commit comments

Comments
 (0)