Fix api doc errors in basics.php

This commit is contained in:
mark_story 2014-05-31 21:53:54 -04:00
parent 15f63e9c81
commit fe2003888b

View file

@ -125,7 +125,7 @@ if (!function_exists('sortByKey')) {
/** /**
* Sorts given $array by key $sortBy. * 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 $sortBy Sort by this key
* @param string $order Sort order asc/desc (ascending or descending). * @param string $order Sort order asc/desc (ascending or descending).
* @param integer $type Type of sorting to perform * @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 * 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(). * print_r() will wrap <PRE> tags around the output of given array. Similar to debug().
* *
* @see debug()
* @param mixed $var Variable to print out * @param mixed $var Variable to print out
* @return void * @return void
* @link http://book.cakephp.org/2.0/en/core-libraries/global-constants-and-functions.html#pr * @link http://book.cakephp.org/2.0/en/core-libraries/global-constants-and-functions.html#pr
* @see debug()
*/ */
function pr($var) { function pr($var) {
if (Configure::read('debug') > 0) { if (Configure::read('debug') > 0) {
@ -254,10 +254,8 @@ if (!function_exists('am')) {
/** /**
* Merge a group of arrays * Merge a group of arrays
* *
* @param array First array * Accepts variable arguments. Each argument will be converted into an array and then merged.
* @param array Second array *
* @param array Third array
* @param array Etc...
* @return array All array parameters merged into one * @return array All array parameters merged into one
* @link http://book.cakephp.org/2.0/en/core-libraries/global-constants-and-functions.html#am * @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 * 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 * @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 * @link http://book.cakephp.org/2.0/en/core-libraries/global-constants-and-functions.html#convertSlash
*/ */