The branch, master has been updated via bb3cb6d99cbba59caef8e91e621c282b192704c9 (commit) via aa459619652ae510b04f99abaa6965acc898ae57 (commit) from 810d1a21c88d9756ddad030adb7dceaead1c0098 (commit)
- Log ----------------------------------------------------------------- commit bb3cb6d99cbba59caef8e91e621c282b192704c9 Author: Michal Čihař mcihar@suse.cz Date: Thu Jul 21 15:32:11 2011 +0200
Fix docblocks
commit aa459619652ae510b04f99abaa6965acc898ae57 Author: Michal Čihař mcihar@suse.cz Date: Thu Jul 21 15:28:39 2011 +0200
Add missing docs
-----------------------------------------------------------------------
Summary of changes: libraries/common.lib.php | 62 +++++++++++++++++++++++----------------------- 1 files changed, 31 insertions(+), 31 deletions(-)
diff --git a/libraries/common.lib.php b/libraries/common.lib.php index cb85c10..b7df61a 100644 --- a/libraries/common.lib.php +++ b/libraries/common.lib.php @@ -9,10 +9,10 @@ /** * Exponential expression / raise number into power * - * @param string $base - * @param string $exp - * @param mixed $use_function pow function to use, or false for auto-detect - * @return mixed string or float + * @param string $base base to raise + * @param string $exp exponent to use + * @param mixed $use_function pow function to use, or false for auto-detect + * @return mixed string or float */ function PMA_pow($base, $exp, $use_function = false) { @@ -62,10 +62,10 @@ function PMA_pow($base, $exp, $use_function = false) /** * string PMA_getIcon(string $icon) * - * @param string $icon name of icon file - * @param string $alternate alternate text - * @param boolean $container include in container - * @param boolean $force_text whether to force alternate text to be displayed + * @param string $icon name of icon file + * @param string $alternate alternate text + * @param boolean $container include in container + * @param boolean $force_text whether to force alternate text to be displayed * @return html img tag */ function PMA_getIcon($icon, $alternate = '', $container = false, $force_text = false) @@ -118,8 +118,8 @@ function PMA_getIcon($icon, $alternate = '', $container = false, $force_text = f /** * Displays the maximum size for an upload * - * @param integer $max_upload_size the size - * @return string the message + * @param integer $max_upload_size the size + * @return string the message * * @access public */ @@ -135,8 +135,8 @@ function PMA_displayMaximumUploadSize($max_upload_size) * Generates a hidden field which should indicate to the browser * the maximum size for upload * - * @param integer $max_size the size - * @return string the INPUT field + * @param integer $max_size the size + * @return string the INPUT field * * @access public */ @@ -149,13 +149,13 @@ function PMA_generateHiddenMaxFileSize($max_size) * Add slashes before "'" and "" characters so a value containing them can * be used in a sql comparison. * - * @param string $a_string the string to slash - * @param bool $is_like whether the string will be used in a 'LIKE' clause - * (it then requires two more escaped sequences) or not - * @param bool $crlf whether to treat cr/lfs as escape-worthy entities - * (converts \n to \n, \r to \r) - * @param bool $php_code whether this function is used as part of the - * "Create PHP code" dialog + * @param string $a_string the string to slash + * @param bool $is_like whether the string will be used in a 'LIKE' clause + * (it then requires two more escaped sequences) or not + * @param bool $crlf whether to treat cr/lfs as escape-worthy entities + * (converts \n to \n, \r to \r) + * @param bool $php_code whether this function is used as part of the + * "Create PHP code" dialog * * @return string the slashed string * @@ -190,8 +190,8 @@ function PMA_sqlAddSlashes($a_string = '', $is_like = false, $crlf = false, $php * database, table and field names. * Note: This function does not escape backslashes! * - * @param string $name the string to escape - * @return string the escaped string + * @param string $name the string to escape + * @return string the escaped string * * @access public */ @@ -224,9 +224,9 @@ function PMA_unescape_mysql_wildcards($name) * * checks if the sting is quoted and removes this quotes * - * @param string $quoted_string string to remove quotes from - * @param string $quote type of quote to remove - * @return string unqoted string + * @param string $quoted_string string to remove quotes from + * @param string $quote type of quote to remove + * @return string unqoted string */ function PMA_unQuote($quoted_string, $quote = null) { @@ -257,8 +257,8 @@ function PMA_unQuote($quoted_string, $quote = null) * format sql strings * * @todo move into PMA_Sql - * @param mixed $parsed_sql pre-parsed SQL structure - * @param string $unparsed_sql + * @param mixed $parsed_sql pre-parsed SQL structure + * @param string $unparsed_sql raw SQL string * @return string the formatted sql * * @global array the configuration array @@ -314,11 +314,11 @@ function PMA_formatSql($parsed_sql, $unparsed_sql = '') /** * Displays a link to the official MySQL documentation * - * @param string $chapter chapter of "HTML, one page per chapter" documentation - * @param string $link contains name of page/anchor that is being linked - * @param bool $big_icon whether to use big icon (like in left frame) - * @param string $anchor anchor to page part - * @param bool $just_open whether only the opening <a> tag should be returned + * @param string $chapter chapter of "HTML, one page per chapter" documentation + * @param string $link contains name of page/anchor that is being linked + * @param bool $big_icon whether to use big icon (like in left frame) + * @param string $anchor anchor to page part + * @param bool $just_open whether only the opening <a> tag should be returned * * @return string the html link *
hooks/post-receive