[Phpmyadmin-git] [SCM] phpMyAdmin branch, master, updated. RELEASE_3_4_3_1-13257-gcdd2044
Michal Čihař
nijel at users.sourceforge.net
Fri Aug 5 15:50:40 CEST 2011
The branch, master has been updated
via cdd2044274fa8de257fbdc873d9df57922c8ba19 (commit)
from 99986466008f4729f29b990b440afc1c9693b220 (commit)
- Log -----------------------------------------------------------------
commit cdd2044274fa8de257fbdc873d9df57922c8ba19
Author: Michal Čihař <mcihar at suse.cz>
Date: Fri Aug 5 15:50:14 2011 +0200
Add some missing spacing in docblocks
-----------------------------------------------------------------------
Summary of changes:
libraries/common.lib.php | 45 +++++++++++++++++++++++++++++++++++++++++++++
1 files changed, 45 insertions(+), 0 deletions(-)
diff --git a/libraries/common.lib.php b/libraries/common.lib.php
index 353e775..e491adb 100644
--- a/libraries/common.lib.php
+++ b/libraries/common.lib.php
@@ -31,6 +31,7 @@ function PMA_detect_pow()
* @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)
@@ -76,6 +77,7 @@ function PMA_pow($base, $exp, $use_function = false)
* @param string $alternate alternate text
* @param boolean $force_text whether to force alternate text to be displayed
* @param boolean $noSprite If true, the image source will be not replaced with a CSS Sprite
+ *
* @return html img tag
*/
function PMA_getIcon($icon, $alternate = '', $force_text = false, $noSprite = false)
@@ -119,6 +121,7 @@ function PMA_getIcon($icon, $alternate = '', $force_text = false, $noSprite = fa
* Displays the maximum size for an upload
*
* @param integer $max_upload_size the size
+ *
* @return string the message
*
* @access public
@@ -136,6 +139,7 @@ function PMA_displayMaximumUploadSize($max_upload_size)
* the maximum size for upload
*
* @param integer $max_size the size
+ *
* @return string the INPUT field
*
* @access public
@@ -191,6 +195,7 @@ function PMA_sqlAddSlashes($a_string = '', $is_like = false, $crlf = false, $php
* Note: This function does not escape backslashes!
*
* @param string $name the string to escape
+ *
* @return string the escaped string
*
* @access public
@@ -208,7 +213,9 @@ function PMA_escape_mysql_wildcards($name)
* Note: This function does not unescape backslashes!
*
* @param string $name the string to escape
+ *
* @return string the escaped string
+ *
* @access public
*/
function PMA_unescape_mysql_wildcards($name)
@@ -226,6 +233,7 @@ function PMA_unescape_mysql_wildcards($name)
*
* @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)
@@ -259,6 +267,7 @@ function PMA_unQuote($quoted_string, $quote = null)
* @todo move into PMA_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
@@ -406,6 +415,7 @@ function PMA_showMySQLDocu($chapter, $link, $big_icon = false, $anchor = '', $ju
* Displays a link to the phpMyAdmin documentation
*
* @param string $anchor anchor in documentation
+ *
* @return string the html link
*
* @access public
@@ -423,6 +433,7 @@ function PMA_showDocu($anchor)
* Displays a link to the PHP documentation
*
* @param string $target anchor in documentation
+ *
* @return string the html link
*
* @access public
@@ -444,7 +455,9 @@ function PMA_showPHPDocu($target)
* @param string $message the error message
* @param bool $bbcode
* @param string $type
+ *
* @return string html code for a footnote marker
+ *
* @access public
*/
function PMA_showHint($message, $bbcode = false, $type = 'notice')
@@ -636,6 +649,7 @@ function PMA_mysqlDie($error_message = '', $the_query = '',
* @param string $tables name of tables
* @param integer $limit_offset list offset
* @param int|bool $limit_count max tables to return
+ *
* @return array (recursive) grouped table list
*/
function PMA_getTableList($db, $tables = null, $limit_offset = 0, $limit_count = false)
@@ -766,7 +780,9 @@ function PMA_getTableList($db, $tables = null, $limit_offset = 0, $limit_count =
* or array of it
* @param boolean $do_it a flag to bypass this function (used by dump
* functions)
+ *
* @return mixed the "backquoted" database, table or field name
+ *
* @access public
*/
function PMA_backquote($a_name, $do_it = true)
@@ -860,7 +876,9 @@ if (!$jsonly)
* @param string $sql_query the query to display
* @param string $type the type (level) of the message
* @param boolean $is_view is this a message after a VIEW operation?
+ *
* @return string
+ *
* @access public
*/
function PMA_showMessage($message, $sql_query = null, $type = 'notice', $is_view = false)
@@ -1216,6 +1234,7 @@ function PMA_showMessage($message, $sql_query = null, $type = 'notice', $is_view
* Verifies if current MySQL server supports profiling
*
* @access public
+ *
* @return boolean whether profiling is supported
*/
function PMA_profilingSupported()
@@ -1301,6 +1320,7 @@ function PMA_formatByteDown($value, $limes = 6, $comma = 0)
* Changes thousands and decimal separators to locale specific values.
*
* @param $value
+ *
* @return string
*/
function PMA_localizeNumber($value)
@@ -1414,6 +1434,7 @@ function PMA_formatNumber($value, $digits_left = 3, $digits_right = 0, $only_dow
* Returns the number of bytes when a formatted size is given
*
* @param string $formatted_size the size expression (for example 8MB)
+ *
* @return integer The numerical part of the expression (for example 8)
*/
function PMA_extractValueFromFormattedSize($formatted_size)
@@ -1435,6 +1456,7 @@ function PMA_extractValueFromFormattedSize($formatted_size)
*
* @param string $timestamp the current timestamp
* @param string $format format
+ *
* @return string the formatted date
*
* @access public
@@ -1504,7 +1526,9 @@ function PMA_localisedDate($timestamp = -1, $format = '')
*
* @param array $tab array with all options
* @param array $url_params
+ *
* @return string html code for one tab, a link if valid otherwise a span
+ *
* @access public
*/
function PMA_generate_html_tab($tab, $url_params = array(), $base_dir='')
@@ -1603,6 +1627,7 @@ function PMA_generate_html_tab($tab, $url_params = array(), $base_dir='')
*
* @param array $tabs one element per tab
* @param string $url_params
+ *
* @return string html-code for tab-navigation
*/
function PMA_generate_html_tabs($tabs, $url_params, $base_dir='')
@@ -1779,6 +1804,7 @@ function PMA_timespanFormat($seconds)
* @param string $Separator The Separator (defaults to "<br />\n")
*
* @access public
+ *
* @return string The flipped string
*/
function PMA_flipstring($string, $Separator = "<br />\n")
@@ -1880,6 +1906,7 @@ function PMA_checkParameters($params, $die = true, $request = true)
* @param boolean $force_unique generate condition only on pk or unique
*
* @access public
+ *
* @return array the calculated condition and whether condition is unique
*/
function PMA_getUniqueCondition($handle, $fields_cnt, $fields_meta, $row, $force_unique=false)
@@ -2049,6 +2076,7 @@ function PMA_buttonOrImage($button_name, $button_class, $image_name, $text,
* @param string $prompt The prompt to display (sometimes empty)
*
* @return string
+ *
* @access public
*/
function PMA_pageselector($rows, $pageNow = 1, $nbTotalPage = 1,
@@ -2223,7 +2251,9 @@ function PMA_listNavigator($count, $pos, $_url_params, $script, $frame, $max_cou
* $user_dir = PMA_userDir('/var/pma_tmp/%u/'); // '/var/pma_tmp/root/'
*
* </code>
+ *
* @param string $dir with wildcard for user
+ *
* @return string per user directory
*/
function PMA_userDir($dir)
@@ -2240,6 +2270,7 @@ function PMA_userDir($dir)
* returns html code for db link to default db page
*
* @param string $database
+ *
* @return string html link to default db page
*/
function PMA_getDbLink($database = null)
@@ -2330,6 +2361,7 @@ function PMA_display_html_radio($html_field_name, $choices, $checked_choice = ''
* @param string $id id of the select element; can be different in case
* the dropdown is present more than once on the page
* @return string
+ *
* @todo support titles
*/
function PMA_generate_html_dropdown($select_name, $choices, $active_choice, $id)
@@ -2467,6 +2499,7 @@ function PMA_clearUserCache()
*
* @param string $var
* @param int|true $server
+ *
* @return boolean
*/
function PMA_cacheExists($var, $server = 0)
@@ -2482,6 +2515,7 @@ function PMA_cacheExists($var, $server = 0)
*
* @param string $var
* @param int|true $server
+ *
* @return mixed
*/
function PMA_cacheGet($var, $server = 0)
@@ -2502,6 +2536,7 @@ function PMA_cacheGet($var, $server = 0)
* @param string $var
* @param mixed $val
* @param int|true $server
+ *
* @return mixed
*/
function PMA_cacheSet($var, $val = null, $server = 0)
@@ -2533,6 +2568,7 @@ function PMA_cacheUnset($var, $server = 0)
*
* @param numeric $value coming from a BIT field
* @param integer $length
+ *
* @return string the printable value
*/
function PMA_printable_bit_value($value, $length)
@@ -2549,6 +2585,7 @@ function PMA_printable_bit_value($value, $length)
* Verifies whether the value contains a non-printable character
*
* @param string $value
+ *
* @return boolean
*/
function PMA_contains_nonprintable_ascii($value)
@@ -2561,6 +2598,7 @@ function PMA_contains_nonprintable_ascii($value)
* for example, b'010' becomes 010
*
* @param string $bit_default_value
+ *
* @return string the converted value
*/
function PMA_convert_bit_default_value($bit_default_value)
@@ -2572,6 +2610,7 @@ function PMA_convert_bit_default_value($bit_default_value)
* Extracts the various parts from a field type spec
*
* @param string $fieldspec
+ *
* @return array associative array containing type, spec_in_brackets
* and possibly enum_set_values (another array)
*/
@@ -2687,6 +2726,7 @@ function PMA_extractFieldSpec($fieldspec)
* Verifies if this table's engine supports foreign keys
*
* @param string $engine
+ *
* @return boolean
*/
function PMA_foreignkey_supported($engine)
@@ -2703,6 +2743,7 @@ function PMA_foreignkey_supported($engine)
* Replaces some characters by a displayable equivalent
*
* @param string $content
+ *
* @return string the content with characters replaced
*/
function PMA_replace_binary_contents($content)
@@ -2719,6 +2760,7 @@ function PMA_replace_binary_contents($content)
* If the string starts with a \r\n pair (0x0d0a) add an extra \n
*
* @param string $string
+ *
* @return string with the chars replaced
*/
@@ -2737,6 +2779,7 @@ function PMA_duplicateFirstNewline($string)
*
* @param string $target a valid value for $cfg['LeftDefaultTabTable'], $cfg['DefaultTabTable']
* or $cfg['DefaultTabDatabase']
+ *
* @return array
*/
function PMA_getTitleForTarget($target)
@@ -2764,6 +2807,7 @@ function PMA_getTitleForTarget($target)
* @param string $string Text where to do expansion.
* @param function $escape Function to call for escaping variable values.
* @param array $updates Array with overrides for default parameters (obtained from GLOBALS).
+ *
* @return string
*/
function PMA_expandUserString($string, $escape = null, $updates = array())
@@ -3154,6 +3198,7 @@ function PMA_getFunctionsForField($field, $insert_mode)
* string, db name where to also check for privileges
* @param mixed $tbl null, to only check global privileges
* string, db name where to also check for privileges
+ *
* @return bool
*/
function PMA_currentUserHasPrivilege($priv, $db = null, $tbl = null)
hooks/post-receive
--
phpMyAdmin
More information about the Git
mailing list