Fix api doc errors in basics.php

cakephp · Jun 1, 2014 · fe20038 · fe20038
1 parent 15f63e9
commit fe20038
Showing 1 changed file with 5 additions and 7 deletions.
diff --git a/lib/Cake/basics.php b/lib/Cake/basics.php
@@ -125,7 +125,7 @@ function debug($var, $showHtml = null, $showFrom = true) {
 /**
  * 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 @@ function pluginSplit($name, $dotAppend = false, $plugin = null) {
  * In terminals this will act the same as using print_r() directly, when not run on cli
  * print_r() will wrap <PRE> 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 @@ function pr($var) {
 /**
  * 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 @@ function fileExistsInPath($file) {
 /**
  * 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
  */