gian/phpmyadmin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix docblocks

Browse Source
This commit is contained in:
Michal Čihař 2011-07-21 15:32:11 +02:00
parent aa45961965
commit bb3cb6d99c
1 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
libraries/common.lib.php
View File

@ -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
*