From fe2003888b500d574360eb2af31a31e8113626a6 Mon Sep 17 00:00:00 2001 From: mark_story Date: Sat, 31 May 2014 21:53:54 -0400 Subject: [PATCH] Fix api doc errors in basics.php --- lib/Cake/basics.php | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/lib/Cake/basics.php b/lib/Cake/basics.php index 60deced1c..02c023b10 100644 --- a/lib/Cake/basics.php +++ b/lib/Cake/basics.php @@ -125,7 +125,7 @@ if (!function_exists('sortByKey')) { /** * Sorts given $array by key $sortBy. * - * @param array $array Array to sort + * @param array &$array Array to sort * @param string $sortBy Sort by this key * @param string $order Sort order asc/desc (ascending or descending). * @param integer $type Type of sorting to perform @@ -235,10 +235,10 @@ if (!function_exists('pr')) { * In terminals this will act the same as using print_r() directly, when not run on cli * print_r() will wrap
 tags around the output of given array. Similar to debug().
  *
- * @see debug()
  * @param mixed $var Variable to print out
  * @return void
  * @link http://book.cakephp.org/2.0/en/core-libraries/global-constants-and-functions.html#pr
+ * @see debug()
  */
 	function pr($var) {
 		if (Configure::read('debug') > 0) {
@@ -254,10 +254,8 @@ if (!function_exists('am')) {
 /**
  * Merge a group of arrays
  *
- * @param array First array
- * @param array Second array
- * @param array Third array
- * @param array Etc...
+ * Accepts variable arguments. Each argument will be converted into an array and then merged.
+ *
  * @return array All array parameters merged into one
  * @link http://book.cakephp.org/2.0/en/core-libraries/global-constants-and-functions.html#am
  */
@@ -840,7 +838,7 @@ if (!function_exists('convertSlash')) {
 /**
  * Convert forward slashes to underscores and removes first and last underscores in a string
  *
- * @param string String to convert
+ * @param string $string String to convert
  * @return string with underscore remove from start and end of string
  * @link http://book.cakephp.org/2.0/en/core-libraries/global-constants-and-functions.html#convertSlash
  */