Skip to content

Commit c455f5e

Browse files
committed
docs: add @return explanations
1 parent 56ef121 commit c455f5e

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

system/Common.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -952,7 +952,7 @@ function response(): ResponseInterface
952952
* @param int|string ...$params One or more parameters to be passed to the route.
953953
* The last parameter allows you to set the locale.
954954
*
955-
* @return false|string
955+
* @return false|string The route (URI path relative to baseURL) or false if not found.
956956
*/
957957
function route_to(string $method, ...$params)
958958
{

system/Router/RouteCollection.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1044,7 +1044,7 @@ public function environment(string $env, Closure $callback): RouteCollectionInte
10441044
* @param int|string ...$params One or more parameters to be passed to the route.
10451045
* The last parameter allows you to set the locale.
10461046
*
1047-
* @return false|string
1047+
* @return false|string The route (URI path relative to baseURL) or false if not found.
10481048
*/
10491049
public function reverseRoute(string $search, ...$params)
10501050
{

system/Router/RouteCollectionInterface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ public function getHTTPVerb();
172172
* @param string $search Named route or Controller::method
173173
* @param int|string ...$params
174174
*
175-
* @return false|string
175+
* @return false|string The route (URI path relative to baseURL) or false if not found.
176176
*/
177177
public function reverseRoute(string $search, ...$params);
178178

0 commit comments

Comments
 (0)