From 4cafa9e3c79051476c54ad81a3e73e7242e7775a Mon Sep 17 00:00:00 2001 From: diosmosis Date: Sun, 8 Dec 2013 02:36:27 +0000 Subject: Refs #4200 revised some of class/method docs. --- core/UrlHelper.php | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) (limited to 'core/UrlHelper.php') diff --git a/core/UrlHelper.php b/core/UrlHelper.php index f6daa0734d..7092906aa7 100644 --- a/core/UrlHelper.php +++ b/core/UrlHelper.php @@ -19,8 +19,7 @@ class UrlHelper { /** * Converts an array of query parameter name/value mappings into a query string. - * Parameters that are in `$parametersToExclude` will not appear in the result - * query string. + * Parameters that are in `$parametersToExclude` will not appear in the result. * * @static * @param $queryParameters Array of query parameters, eg, `array('site' => '0', 'date' => '2012-01-01')`. @@ -113,7 +112,7 @@ class UrlHelper * Returns a URL created from the result of the [parse_url](http://php.net/manual/en/function.parse-url.php) * function. * - * Copied from the PHP comments at http://php.net/parse_url + * Copied from the PHP comments at [http://php.net/parse_url](http://php.net/parse_url). * * @param array $parsed Result of [parse_url](http://php.net/manual/en/function.parse-url.php). * @return false|string The URL or `false` if `$parsed` isn't an array. @@ -144,7 +143,7 @@ class UrlHelper /** * Returns a URL query string as an array. * - * @param string $urlQuery The query string. + * @param string $urlQuery The query string, eg, `'?param1=value1¶m2=value2'`. * @return array eg, `array('param1' => 'value1', 'param2' => 'value2')` * @api */ @@ -221,7 +220,7 @@ class UrlHelper /** * Returns the path and query string of a URL. * - * @param string $url + * @param string $url The URL. * @return string eg, `/test/index.php?module=CoreHome` if `$url` is `http://piwik.org/test/index.php?module=CoreHome`. * @api */ -- cgit v1.2.3