diff options
| author | Tristan Darricau <github@nicofuma.fr> | 2014-06-15 12:38:00 +0200 |
|---|---|---|
| committer | Tristan Darricau <github@nicofuma.fr> | 2014-06-15 19:14:10 +0200 |
| commit | 358a10d8a9e244572568e89cdb87fd83f42759cf (patch) | |
| tree | c81471893c59832e6288323a6a3f389a732f0b43 /phpBB/phpbb/controller | |
| parent | 8966e4a26970bb082fc02e8e4e57144567e95d31 (diff) | |
| download | forums-358a10d8a9e244572568e89cdb87fd83f42759cf.tar forums-358a10d8a9e244572568e89cdb87fd83f42759cf.tar.gz forums-358a10d8a9e244572568e89cdb87fd83f42759cf.tar.bz2 forums-358a10d8a9e244572568e89cdb87fd83f42759cf.tar.xz forums-358a10d8a9e244572568e89cdb87fd83f42759cf.zip | |
[ticket/12715] Cleanup comments in \phpbb\controller\*
PHPBB3-12715
Diffstat (limited to 'phpBB/phpbb/controller')
| -rw-r--r-- | phpBB/phpbb/controller/helper.php | 6 | ||||
| -rw-r--r-- | phpBB/phpbb/controller/provider.php | 8 | ||||
| -rw-r--r-- | phpBB/phpbb/controller/resolver.php | 2 |
3 files changed, 9 insertions, 7 deletions
diff --git a/phpBB/phpbb/controller/helper.php b/phpBB/phpbb/controller/helper.php index 7b232294f0..930bc42a98 100644 --- a/phpBB/phpbb/controller/helper.php +++ b/phpBB/phpbb/controller/helper.php @@ -101,7 +101,7 @@ class helper * @param string $route Name of the route to travel * @param array $params String or array of additional url parameters * @param bool $is_amp Is url using & (true) or & (false) - * @param string $session_id Possibility to use a custom session id instead of the global one + * @param string|bool $session_id Possibility to use a custom session id instead of the global one * @return string The URL already passed through append_sid() */ public function route($route, array $params = array(), $is_amp = true, $session_id = false) @@ -139,8 +139,8 @@ class helper * Output an error, effectively the same thing as trigger_error * * @param string $message The error message - * @param string $code The error code (e.g. 404, 500, 503, etc.) - * @return Response A Reponse instance + * @param int $code The error code (e.g. 404, 500, 503, etc.) + * @return Response A Response instance */ public function error($message, $code = 500) { diff --git a/phpBB/phpbb/controller/provider.php b/phpBB/phpbb/controller/provider.php index bd85385a41..fffd4f0428 100644 --- a/phpBB/phpbb/controller/provider.php +++ b/phpBB/phpbb/controller/provider.php @@ -37,7 +37,7 @@ class provider /** * Construct method * - * @param array() $routing_files Array of strings containing paths + * @param array $routing_files Array of strings containing paths * to YAML files holding route information */ public function __construct($routing_files = array()) @@ -46,6 +46,8 @@ class provider } /** + * Find the list of routing files + * * @param \phpbb\finder $finder * @return null */ @@ -61,10 +63,10 @@ class provider } /** - * Find a list of controllers and return it + * Find a list of controllers * * @param string $base_path Base path to prepend to file paths - * @return null + * @return provider */ public function find($base_path = '') { diff --git a/phpBB/phpbb/controller/resolver.php b/phpBB/phpbb/controller/resolver.php index 77532767fc..efab34b701 100644 --- a/phpBB/phpbb/controller/resolver.php +++ b/phpBB/phpbb/controller/resolver.php @@ -122,7 +122,7 @@ class resolver implements ControllerResolverInterface * * @param \Symfony\Component\HttpFoundation\Request $request Symfony Request object * @param mixed $controller A callable (controller class, method) - * @return bool False + * @return array An array of arguments to pass to the controller * @throws \phpbb\controller\exception */ public function getArguments(Request $request, $controller) |