Permalink
Browse files

Remove @uses tags from docblocks

  • Loading branch information...
1 parent 327b3d1 commit e57f27e50ba565be52ed3d271d6c9076f2ae48fd @nijel nijel committed Jun 27, 2011
Showing with 0 additions and 2,047 deletions.
  1. +0 −4 db_export.php
  2. +0 −25 db_search.php
  3. +0 −1 import.php
  4. +0 −19 index.php
  5. +0 −44 libraries/Config.class.php
  6. +0 −55 libraries/Error.class.php
  7. +0 −62 libraries/Error_Handler.class.php
  8. +0 −70 libraries/File.class.php
  9. +0 −19 libraries/Index.class.php
  10. +0 −11 libraries/List.class.php
  11. +0 −49 libraries/List_Database.class.php
  12. +0 −87 libraries/Message.class.php
  13. +0 −4 libraries/PMA.php
  14. +0 −2 libraries/Partition.class.php
  15. +0 −7 libraries/RecentTable.class.php
  16. +0 −39 libraries/StorageEngine.class.php
  17. +0 −14 libraries/Table.class.php
  18. +0 −44 libraries/Theme.class.php
  19. +0 −7 libraries/Theme_Manager.class.php
  20. +0 −75 libraries/auth/cookie.auth.lib.php
  21. +0 −9 libraries/blobstreaming.lib.php
  22. +0 −22 libraries/bookmark.lib.php
  23. +0 −21 libraries/check_user_privileges.lib.php
  24. +0 −121 libraries/common.lib.php
  25. +0 −8 libraries/config/ConfigFile.class.php
  26. +0 −5 libraries/config/Form.class.php
  27. +0 −40 libraries/config/FormDisplay.class.php
  28. +0 −10 libraries/config/FormDisplay.tpl.php
  29. +0 −11 libraries/config/validate.lib.php
  30. +0 −59 libraries/core.lib.php
  31. +0 −68 libraries/database_interface.lib.php
  32. +0 −25 libraries/db_info.inc.php
  33. +0 −61 libraries/db_routines.lib.php
  34. +0 −5 libraries/db_structure.lib.php
  35. +0 −15 libraries/dbi/mysql.dbi.lib.php
  36. +0 −84 libraries/dbi/mysqli.dbi.lib.php
  37. +0 −69 libraries/display_tbl.lib.php
  38. +0 −14 libraries/engines/innodb.lib.php
  39. +0 −25 libraries/footer.inc.php
  40. +0 −5 libraries/grab_globals.lib.php
  41. +0 −2 libraries/header.inc.php
  42. +0 −65 libraries/import.lib.php
  43. +0 −7 libraries/js_escape.lib.php
  44. +0 −8 libraries/mysql_charsets.lib.php
  45. +0 −12 libraries/ob.lib.php
  46. +0 −26 libraries/plugin_interface.lib.php
  47. +0 −124 libraries/relation.lib.php
  48. +0 −12 libraries/relation_cleanup.lib.php
  49. +0 −1 libraries/replication_gui.lib.php
  50. +0 −2 libraries/sanitizing.lib.php
  51. +0 −15 libraries/select_lang.lib.php
  52. +0 −6 libraries/select_server.lib.php
  53. +0 −6 libraries/server_common.inc.php
  54. +0 −49 libraries/server_synchronize.lib.php
  55. +0 −4 libraries/session.inc.php
  56. +0 −52 libraries/sql_query_form.lib.php
  57. +0 −10 libraries/string.lib.php
  58. +0 −7 libraries/string_type_ctype.lib.php
  59. +0 −15 libraries/string_type_native.lib.php
  60. +0 −9 libraries/tbl_replace_fields.inc.php
  61. +0 −29 libraries/transformations.lib.php
  62. +0 −17 libraries/url_generating.lib.php
  63. +0 −41 libraries/user_preferences.lib.php
  64. +0 −55 navigation.php
  65. +0 −47 pmd_common.php
  66. +0 −24 querywindow.php
  67. +0 −19 server_binlog.php
  68. +0 −26 tbl_create.php
  69. +0 −27 tbl_replace.php
  70. +0 −1 test/theme.php
  71. +0 −14 user_password.php
View
4 db_export.php
@@ -3,10 +3,6 @@
/**
* dumps a database
*
- * @uses libraries/db_common.inc.php
- * @uses libraries/db_info.inc.php
- * @uses libraries/display_export.lib.php
- * @uses $tables from libraries/db_info.inc.php
* @package phpMyAdmin
*/
View
25 db_search.php
@@ -5,30 +5,6 @@
*
* @todo make use of UNION when searching multiple tables
* @todo display executed query, optional?
- * @uses $cfg['UseDbSearch']
- * @uses $GLOBALS['db']
- * @uses PMA_DBI_get_tables()
- * @uses PMA_sqlAddslashes()
- * @uses PMA_getSearchSqls()
- * @uses PMA_DBI_fetch_value()
- * @uses PMA_linkOrButton()
- * @uses PMA_generate_common_url()
- * @uses PMA_generate_common_hidden_inputs()
- * @uses PMA_showMySQLDocu()
- * @uses $_REQUEST['search_str']
- * @uses $_REQUEST['submit_search']
- * @uses $_REQUEST['search_option']
- * @uses $_REQUEST['table_select']
- * @uses $_REQUEST['unselectall']
- * @uses $_REQUEST['selectall']
- * @uses $_REQUEST['field_str']
- * @uses is_string()
- * @uses htmlspecialchars()
- * @uses array_key_exists()
- * @uses is_array()
- * @uses array_intersect()
- * @uses sprintf()
- * @uses in_array()
* @package phpMyAdmin
*/
@@ -130,7 +106,6 @@
* Builds the SQL search query
*
* @todo can we make use of fulltextsearch IN BOOLEAN MODE for this?
- * @uses PMA_DBI_query
* PMA_backquote
* PMA_DBI_free_result
* PMA_DBI_fetch_assoc
View
1 import.php
@@ -3,7 +3,6 @@
/**
* Core script for import, this is just the glue around all other stuff
*
- * @uses PMA_Bookmark_getList()
* @package phpMyAdmin
*/
View
19 index.php
@@ -3,26 +3,7 @@
/**
* forms frameset
*
- * @uses $GLOBALS['cfg']['QueryHistoryDB']
- * @uses $GLOBALS['cfg']['Server']['user']
- * @uses $GLOBALS['cfg']['DefaultTabServer'] as src for the mainframe
- * @uses $GLOBALS['cfg']['DefaultTabDatabase'] as src for the mainframe
- * @uses $GLOBALS['cfg']['NaviWidth'] for navi frame width
- * @uses $GLOBALS['collation_connection'] from $_REQUEST (grab_globals.lib.php)
* or common.inc.php
- * @uses $GLOBALS['available_languages'] from common.inc.php (select_lang.lib.php)
- * @uses $GLOBALS['db']
- * @uses $GLOBALS['lang']
- * @uses $GLOBALS['text_dir']
- * @uses $_ENV['HTTP_HOST']
- * @uses PMA_getRelationsParam()
- * @uses PMA_purgeHistory()
- * @uses PMA_generate_common_url()
- * @uses PMA_VERSION
- * @uses session_write_close()
- * @uses time()
- * @uses PMA_getenv()
- * @uses header() to send charset
* @package phpMyAdmin
*/
View
44 libraries/Config.class.php
@@ -305,10 +305,6 @@ function checkPhpVersion()
/**
* loads default values from default source
*
- * @uses file_exists()
- * @uses $this->default_source
- * @uses $this->error_config_default_file
- * @uses $this->settings
* @return boolean success
*/
function loadDefaults()
@@ -418,16 +414,6 @@ function load($source = null)
* Loads user preferences and merges them with current config
* must be called after control connection has been estabilished
*
- * @uses $GLOBALS['cfg']
- * @uses $GLOBALS['collation_connection']
- * @uses $GLOBALS['lang']
- * @uses $_SESSION['cache']['server_$server']['config_mtime']
- * @uses $_SESSION['cache']['server_$server']['userprefs']
- * @uses $_SESSION['cache']['server_$server']['userprefs_mtime']
- * @uses $_SESSION['PMA_Theme_Manager']
- * @uses PMA_apply_userprefs()
- * @uses PMA_array_merge_recursive()
- * @uses PMA_load_userprefs()
* @return boolean
*/
function loadUserPreferences()
@@ -530,10 +516,6 @@ function loadUserPreferences()
* If user preferences are not yet initialized, option is applied to global config and
* added to a update queue, which is processed by {@link loadUserPreferences()}
*
- * @uses $GLOBALS['cfg']
- * @uses PMA_array_read()
- * @uses PMA_array_write()
- * @uses PMA_persist_option()
* @param string $cookie_name can be null
* @param string $cfg_path
* @param mixed $new_cfg_value
@@ -672,7 +654,6 @@ function get($setting)
/**
* sets configuration variable
*
- * @uses $this->settings
* @param string $setting configuration option
* @param string $value new value for configuration option
*/
@@ -890,14 +871,6 @@ function checkCollationConnection()
/**
* checks for font size configuration, and sets font size as requested by user
*
- * @uses $_GET
- * @uses $_POST
- * @uses $_COOKIE
- * @uses preg_match()
- * @uses function_exists()
- * @uses PMA_Config::set()
- * @uses PMA_Config::get()
- * @uses PMA_Config::setCookie()
*/
function checkFontsize()
{
@@ -1105,8 +1078,6 @@ function save() {}
/**
* returns options for font size selection
*
- * @uses preg_replace()
- * @uses ksort()
* @static
* @param string $current_size current selected font size with unit
* @return array selectable font sizes
@@ -1167,9 +1138,6 @@ static protected function _getFontsizeOptions($current_size = '82%')
/**
* returns html selectbox for font sizes
*
- * @uses $GLOBALS['PMA_Config']
- * @uses PMA_Config::get()
- * @uses PMA_Config::_getFontsizeOptions()
* @static
* @param string $current_size currently slected font size with unit
* @return string html selectbox
@@ -1204,8 +1172,6 @@ static protected function _getFontsizeSelection()
/**
* return complete font size selection form
*
- * @uses PMA_generate_common_hidden_inputs()
- * @uses PMA_Config::_getFontsizeSelection()
* @static
* @param string $current_size currently slected font size with unit
* @return string html selectbox
@@ -1225,10 +1191,6 @@ static public function getFontsizeForm()
/**
* removes cookie
*
- * @uses PMA_Config::isHttps()
- * @uses PMA_Config::getCookiePath()
- * @uses setcookie()
- * @uses time()
* @param string $cookie name of cookie to remove
* @return boolean result of setcookie()
*/
@@ -1242,12 +1204,6 @@ function removeCookie($cookie)
* sets cookie if value is different from current cokkie value,
* or removes if value is equal to default
*
- * @uses PMA_Config::isHttps()
- * @uses PMA_Config::getCookiePath()
- * @uses $_COOKIE
- * @uses PMA_Config::removeCookie()
- * @uses setcookie()
- * @uses time()
* @param string $cookie name of cookie to remove
* @param mixed $value new cookie value
* @param string $default default value
View
55 libraries/Error.class.php
@@ -93,12 +93,6 @@ class PMA_Error extends PMA_Message
/**
* Constructor
*
- * @uses debug_backtrace()
- * @uses PMA_Error::setNumber()
- * @uses PMA_Error::setMessage()
- * @uses PMA_Error::setFile()
- * @uses PMA_Error::setLine()
- * @uses PMA_Error::setBacktrace()
* @param integer $errno
* @param string $errstr
* @param string $errfile
@@ -122,7 +116,6 @@ public function __construct($errno, $errstr, $errfile, $errline)
/**
* sets PMA_Error::$_backtrace
*
- * @uses PMA_Error::$_backtrace to set it
* @param array $backtrace
*/
public function setBacktrace($backtrace)
@@ -133,7 +126,6 @@ public function setBacktrace($backtrace)
/**
* sets PMA_Error::$_line
*
- * @uses PMA_Error::$_line to set it
* @param integer $line
*/
public function setLine($line)
@@ -144,8 +136,6 @@ public function setLine($line)
/**
* sets PMA_Error::$_file
*
- * @uses PMA_Error::$_file to set it
- * @uses PMA_Error::relPath()
* @param string $file
*/
public function setFile($file)
@@ -157,13 +147,6 @@ public function setFile($file)
/**
* returns unique PMA_Error::$_hash, if not exists it will be created
*
- * @uses PMA_Error::$_hash as return value and to set it if required
- * @uses PMA_Error::getNumber()
- * @uses PMA_Error::getMessage()
- * @uses PMA_Error::getFile()
- * @uses PMA_Error::getLine()
- * @uses PMA_Error::getBacktrace()
- * @uses md5()
* @param string $file
* @return string PMA_Error::$_hash
*/
@@ -185,7 +168,6 @@ public function getHash()
/**
* returns PMA_Error::$_backtrace
*
- * @uses PMA_Error::$_backtrace as return value
* @return array PMA_Error::$_backtrace
*/
public function getBacktrace()
@@ -196,7 +178,6 @@ public function getBacktrace()
/**
* returns PMA_Error::$_file
*
- * @uses PMA_Error::$_file as return value
* @return string PMA_Error::$_file
*/
public function getFile()
@@ -207,7 +188,6 @@ public function getFile()
/**
* returns PMA_Error::$_line
*
- * @uses PMA_Error::$_line as return value
* @return integer PMA_Error::$_line
*/
public function getLine()
@@ -218,8 +198,6 @@ public function getLine()
/**
* returns type of error
*
- * @uses PMA_Error::$errortype
- * @uses PMA_Error::getNumber()
* @return string type of error
*/
public function getType()
@@ -230,8 +208,6 @@ public function getType()
/**
* returns level of error
*
- * @uses PMA_Error::$$errorlevel
- * @uses PMA_Error::getNumber()
* @return string level of error
*/
public function getLevel()
@@ -242,9 +218,6 @@ public function getLevel()
/**
* returns title prepared for HTML Title-Tag
*
- * @uses PMA_Error::getTitle()
- * @uses htmlspecialchars()
- * @uses substr()
* @return string HTML escaped and truncated title
*/
public function getHtmlTitle()
@@ -255,8 +228,6 @@ public function getHtmlTitle()
/**
* returns title for error
*
- * @uses PMA_Error::getType()
- * @uses PMA_Error::getMessage()
* @return string
*/
public function getTitle()
@@ -267,10 +238,6 @@ public function getTitle()
/**
* Display HTML backtrace
*
- * @uses PMA_Error::getBacktrace()
- * @uses PMA_Error::relPath()
- * @uses PMA_Error::displayArg()
- * @uses count()
*/
public function displayBacktrace()
{
@@ -300,9 +267,6 @@ public function displayBacktrace()
* Display a single function argument
* if $function is one of include/require the $arg is converted te relative path
*
- * @uses PMA_Error::relPath()
- * @uses in_array()
- * @uses gettype()
* @param string $arg
* @param string $function
*/
@@ -327,11 +291,6 @@ protected function displayArg($arg, $function)
/**
* Displays the error in HTML
*
- * @uses PMA_Error::getLevel()
- * @uses PMA_Error::getType()
- * @uses PMA_Error::getMessage()
- * @uses PMA_Error::displayBacktrace()
- * @uses PMA_Error::isDisplayed()
*/
public function display()
{
@@ -356,10 +315,6 @@ public function display()
/**
* whether this error is a user error
*
- * @uses E_USER_WARNING
- * @uses E_USER_ERROR
- * @uses E_USER_NOTICE
- * @uses PMA_Error::getNumber()
* @return boolean
*/
public function isUserError()
@@ -374,16 +329,6 @@ public function isUserError()
* and make users feel save to submit error reports
*
* @static
- * @uses PHP_OS()
- * @uses __FILE__()
- * @uses realpath()
- * @uses substr()
- * @uses explode()
- * @uses dirname()
- * @uses implode()
- * @uses count()
- * @uses array_pop()
- * @uses str_replace()
* @param string $dest path to be shorten
* @return string shortened path
*/
View
62 libraries/Error_Handler.class.php
@@ -28,7 +28,6 @@ class PMA_Error_Handler
/**
* Constructor - set PHP error handler
*
- * @uses set_error_handler()
*/
public function __construct()
{
@@ -40,10 +39,6 @@ public function __construct()
*
* stores errors in session
*
- * @uses $_SESSION['errors']
- * @uses array_merge()
- * @uses PMA_Error_Handler::$_errors
- * @uses PMA_Error::isDisplayed()
*/
public function __destruct()
{
@@ -69,8 +64,6 @@ public function __destruct()
/**
* returns array with all errors
*
- * @uses PMA_Error_Handler::$_errors as return value
- * @uses PMA_Error_Handler::_checkSavedErrors()
* @return array PMA_Error_Handler::$_errors
*/
protected function getErrors()
@@ -90,24 +83,6 @@ protected function getErrors()
* Do not use the context parameter as we want to avoid storing the
* complete $GLOBALS inside $_SESSION['errors']
*
- * @uses E_USER_NOTICE
- * @uses E_USER_WARNING
- * @uses E_STRICT
- * @uses E_NOTICE
- * @uses E_WARNING
- * @uses E_CORE_WARNING
- * @uses E_COMPILE_WARNING
- * @uses E_USER_ERROR
- * @uses E_ERROR
- * @uses E_PARSE
- * @uses E_CORE_ERROR
- * @uses E_COMPILE_ERROR
- * @uses E_RECOVERABLE_ERROR
- * @uses PMA_Error
- * @uses PMA_Error_Handler::$_errors
- * @uses PMA_Error_Handler::_dispFatalError()
- * @uses PMA_Error::getHash()
- * @uses PMA_Error::getNumber()
* @param integer $errno
* @param string $errstr
* @param string $errfile
@@ -151,8 +126,6 @@ public function handleError($errno, $errstr, $errfile, $errline)
* log error to configured log facility
*
* @todo finish!
- * @uses PMA_Error::getMessage()
- * @uses error_log()
* @param PMA_Error $error
*/
protected function _logError($error)
@@ -163,7 +136,6 @@ protected function _logError($error)
/**
* trigger a custom error
*
- * @uses trigger_error()
* @param string $errorInfo
* @param integer $errorNumber
* @param string $file
@@ -178,10 +150,6 @@ public function triggerError($errorInfo, $errorNumber = null, $file = null, $lin
/**
* display fatal error and exit
*
- * @uses headers_sent()
- * @uses PMA_Error::display()
- * @uses PMA_Error_Handler::_dispPageStart()
- * @uses PMA_Error_Handler::_dispPageEnd()
* @param PMA_Error $error
*/
protected function _dispFatalError($error)
@@ -197,10 +165,6 @@ protected function _dispFatalError($error)
/**
* display the whole error page with all errors
*
- * @uses headers_sent()
- * @uses PMA_Error_Handler::dispAllErrors()
- * @uses PMA_Error_Handler::_dispPageStart()
- * @uses PMA_Error_Handler::_dispPageEnd()
*/
public function dispErrorPage()
{
@@ -214,10 +178,6 @@ public function dispErrorPage()
/**
* display user errors not displayed
*
- * @uses PMA_Error_Handler::getErrors()
- * @uses PMA_Error::isDisplayed()
- * @uses PMA_Error::isUserError()
- * @uses PMA_Error::display()
*/
public function dispUserErrors()
{
@@ -231,7 +191,6 @@ public function dispUserErrors()
/**
* display HTML header
*
- * @uses PMA_Error::getTitle()
* @param PMA_error $error
*/
protected function _dispPageStart($error = null)
@@ -257,8 +216,6 @@ protected function _dispPageEnd()
/**
* display all errors regardless already displayed or user errors
*
- * @uses PMA_Error_Handler::getErrors()
- * @uses PMA_Error::display()
*/
public function dispAllErrors()
{
@@ -270,11 +227,6 @@ public function dispAllErrors()
/**
* display errors not displayed
*
- * @uses $cfg['Error_Handler']['display']
- * @uses PMA_Error_Handler::getErrors()
- * @uses PMA_Error_Handler::dispUserErrors()
- * @uses PMA_Error::isDisplayed()
- * @uses PMA_Error::display()
*/
public function dispErrors()
{
@@ -296,9 +248,6 @@ public function dispErrors()
/**
* look in session for saved errors
*
- * @uses $_SESSION['errors']
- * @uses PMA_Error_Handler::$_errors
- * @uses array_merge()
*/
protected function _checkSavedErrors()
{
@@ -321,8 +270,6 @@ protected function _checkSavedErrors()
/**
* return count of errors
*
- * @uses PMA_Error_Handler::getErrors()
- * @uses count()
* @return integer number of errors occoured
*/
public function countErrors()
@@ -333,9 +280,6 @@ public function countErrors()
/**
* return count of user errors
*
- * @uses PMA_Error_Handler::countErrors()
- * @uses PMA_Error_Handler::getErrors()
- * @uses PMA_Error::isUserError()
* @return integer number of user errors occoured
*/
public function countUserErrors()
@@ -355,7 +299,6 @@ public function countUserErrors()
/**
* whether use errors occured or not
*
- * @uses PMA_Error_Handler::countUserErrors()
* @return boolean
*/
public function hasUserErrors()
@@ -366,7 +309,6 @@ public function hasUserErrors()
/**
* whether errors occured or not
*
- * @uses PMA_Error_Handler::countErrors()
* @return boolean
*/
public function hasErrors()
@@ -377,9 +319,6 @@ public function hasErrors()
/**
* number of errors to be displayed
*
- * @uses $cfg['Error_Handler']['display']
- * @uses PMA_Error_Handler::countErrors()
- * @uses PMA_Error_Handler::countUserErrors()
* @return integer number of errors to be displayed
*/
public function countDisplayErrors()
@@ -394,7 +333,6 @@ public function countDisplayErrors()
/**
* whether there are errors to display or not
*
- * @uses PMA_Error_Handler::countDisplayErrors()
* @return boolean
*/
public function hasDisplayErrors()
View
70 libraries/File.class.php
@@ -79,7 +79,6 @@ class PMA_File
* constructor
*
* @access public
- * @uses PMA_File::setName()
* @param string $name file name
*/
function __construct($name = false)
@@ -94,7 +93,6 @@ function __construct($name = false)
*
* @see PMA_File::cleanUp()
* @access public
- * @uses PMA_File::cleanUp()
*/
function __destruct()
{
@@ -105,8 +103,6 @@ function __destruct()
* deletes file if it is temporary, usally from a moved upload file
*
* @access public
- * @uses PMA_File::delet()
- * @uses PMA_File::isTemp()
* @return boolean success
*/
function cleanUp()
@@ -122,8 +118,6 @@ function cleanUp()
* deletes the file
*
* @access public
- * @uses PMA_File::getName()
- * @uses unlink()
* @return boolean success
*/
function delete()
@@ -136,7 +130,6 @@ function delete()
* file objects with temp flags are deleted with object destruction
*
* @access public
- * @uses PMA_File::$_is_temp to set and read it
* @param boolean sets the temp flag
* @return boolean PMA_File::$_is_temp
*/
@@ -153,7 +146,6 @@ function isTemp($is_temp = null)
* accessor
*
* @access public
- * @uses PMA_File::$_name
* @param string $name file name
*/
function setName($name)
@@ -163,17 +155,6 @@ function setName($name)
/**
* @access public
- * @uses PMA_File::getName()
- * @uses PMA_File::isUploaded()
- * @uses PMA_File::checkUploadedFile()
- * @uses PMA_File::isReadable()
- * @uses PMA_File::$_content
- * @uses function_exists()
- * @uses file_get_contents()
- * @uses filesize()
- * @uses fread()
- * @uses fopen()
- * @uses bin2hex()
* @return string binary file content
*/
function getContent($as_binary = true, $offset = 0, $length = null)
@@ -209,8 +190,6 @@ function getContent($as_binary = true, $offset = 0, $length = null)
/**
* @access public
- * @uses PMA_File::getName()
- * @uses is_uploaded_file()
*/
function isUploaded()
{
@@ -221,7 +200,6 @@ function isUploaded()
* accessor
*
* @access public
- * @uses PMA_File::$name as return value
* @return string PMA_File::$_name
*/
function getName()
@@ -232,9 +210,6 @@ function getName()
/**
* @todo replace error message with localized string
* @access public
- * @uses PMA_File::isUploaded()
- * @uses PMA_File::setName()
- * @uses PMA_File::$_error_message
* @param string name of file uploaded
* @return boolean success
*/
@@ -253,12 +228,6 @@ function setUploadedFile($name)
/**
* @access public
- * @uses PMA_File::fetchUploadedFromTblChangeRequestMultiple()
- * @uses PMA_File::setUploadedFile()
- * @uses PMA_File::setRecentBLOBReference()
- * @uses curl_setopt_array()
- * @uses PMA_File::$_error_message
- * @uses $_FILES
* @param string $key the md5 hash of the column name
* @param string $rownumber
* @return boolean success
@@ -375,9 +344,6 @@ function fetchUploadedFromTblChangeRequestMultiple($file, $rownumber, $key)
* sets the name if the file to the one selected in the tbl_change form
*
* @access public
- * @uses $_REQUEST
- * @uses PMA_File::setLocalSelectedFile()
- * @uses is_string()
* @param string $key the md5 hash of the column name
* @param string $rownumber
* @return boolean success
@@ -437,7 +403,6 @@ function setSelectedFromTblChangeRequest($key, $rownumber = null)
/**
* @access public
- * @uses PMA_File->$_error_message as return value
* @return string error message
*/
function getError()
@@ -447,7 +412,6 @@ function getError()
/**
* @access public
- * @uses PMA_File->$_error_message to check it
* @return boolean whether an error occured or not
*/
function isError()
@@ -460,8 +424,6 @@ function isError()
* and uses the submitted/selected file
*
* @access public
- * @uses PMA_File::setUploadedFromTblChangeRequest()
- * @uses PMA_File::setSelectedFromTblChangeRequest()
* @param string $key the md5 hash of the column name
* @param string $rownumber
* @return boolean success
@@ -485,10 +447,6 @@ function checkTblChangeForm($key, $rownumber)
/**
*
* @access public
- * @uses PMA_File::setName()
- * @uses PMA_securePath()
- * @uses PMA_userDir()
- * @uses $GLOBALS['cfg']['UploadDir']
* @param string $name
* @return boolean success
*/
@@ -508,10 +466,6 @@ function setLocalSelectedFile($name)
/**
* @access public
- * @uses PMA_File::getName()
- * @uses is_readable()
- * @uses ob_start()
- * @uses ob_end_clean()
* @return boolean whether the file is readable or not
*/
function isReadable()
@@ -532,20 +486,6 @@ function isReadable()
* @todo replace error message with localized string
* @todo move check of $cfg['TempDir'] into PMA_Config?
* @access public
- * @uses $cfg['TempDir']
- * @uses PMA_File::isReadable()
- * @uses PMA_File::getName()
- * @uses PMA_File::setName()
- * @uses PMA_File::isTemp()
- * @uses PMA_File::$_error_message
- * @uses is_dir()
- * @uses mkdir()
- * @uses chmod()
- * @uses is_writable()
- * @uses basename()
- * @uses move_uploaded_file()
- * @uses ob_start()
- * @uses ob_end_clean()
* @return boolean whether uploaded fiel is fine or not
*/
function checkUploadedFile()
@@ -588,14 +528,6 @@ function checkUploadedFile()
*
* @todo move file read part into readChunk() or getChunk()
* @todo add support for compression plugins
- * @uses PMA_File::$_compression to set it
- * @uses PMA_File::getName()
- * @uses fopen()
- * @uses fread()
- * @uses strlen()
- * @uses fclose()
- * @uses chr()
- * @uses substr()
* @access protected
* @return string MIME type of compression, none for none
*/
@@ -729,8 +661,6 @@ function setCharset($charset)
}
/**
- * @uses PMA_File::$_compression as return value
- * @uses PMA_File::detectCompression()
* @return string MIME type of compression, none for none
* @access public
*/
View
19 libraries/Index.class.php
@@ -86,7 +86,6 @@ class PMA_Index
/**
* Constructor
*
- * @uses $this->set()
* @param array $params
*/
public function __construct($params = array())
@@ -112,8 +111,6 @@ static public function singleton($schema, $table, $index_name = '')
/**
* returns an array with all indexes from the given table
*
- * @uses PMA_Index::_loadIndexes()
- * @uses PMA_Index::$_registry
* @param string $table
* @param string $schema
* @return array
@@ -132,8 +129,6 @@ static public function getFromTable($table, $schema)
/**
* return primary if set, false otherwise
*
- * @uses PMA_Index::_loadIndexes()
- * @uses PMA_Index::$_registry
* @param string $table
* @param string $schema
* @return mixed primary index or false if no one exists
@@ -152,11 +147,6 @@ static public function getPrimary($table, $schema)
/**
* Load index data for table
*
- * @uses PMA_Index::$_registry
- * @uses PMA_DBI_fetch_result()
- * @uses PMA_backquote()
- * @uses PMA_Index
- * @uses PMA_Index->addColumn()
* @param string $table
* @param string $schema
* @return boolean
@@ -186,8 +176,6 @@ static protected function _loadIndexes($table, $schema)
/**
* Add column to index
*
- * @uses $this->_columns
- * @uses PMA_Index_Column
* @param array $params column params
*/
public function addColumn($params)
@@ -227,7 +215,6 @@ public function addColumns($columns)
/**
* Returns true if $column indexed in this index
*
- * @uses $this->_columns
* @param string $column
* @return boolean
*/
@@ -546,12 +533,6 @@ public function getCompareData()
/**
* Function to check over array of indexes and look for common problems
*
- * @uses is_string()
- * @uses is_array()
- * @uses count()
- * @uses array_pop()
- * @uses reset()
- * @uses current()
* @access public
* @param string name of table
* @return string Output HTML
View
11 libraries/List.class.php
@@ -27,9 +27,6 @@ public function __construct($array = array(), $flags = 0, $iterator_class = "Arr
/**
* returns item only if there is only one in the list
*
- * @uses count()
- * @uses reset()
- * @uses PMA_List::getEmpty() to return it
* @return single item
*/
public function getSingleItem()
@@ -44,7 +41,6 @@ public function getSingleItem()
/**
* defines what is an empty item (0, '', false or null)
*
- * @uses PMA_List::$item_empty as return value
* @return mixed an empty item
*/
public function getEmpty()
@@ -56,9 +52,6 @@ public function getEmpty()
* checks if the given db names exists in the current list, if there is
* missing at least one item it returns false otherwise true
*
- * @uses PMA_List::$items to check for existence of specific item
- * @uses func_get_args()
- * @uses in_array() to check if given arguments exists in PMA_List::$items
* @param string $db_name,.. one or more mysql result resources
* @return boolean true if all items exists, otheriwse false
*/
@@ -77,9 +70,6 @@ public function exists()
/**
* returns HTML <option>-tags to be used inside <select></select>
*
- * @uses PMA_List::$items to build up the option items
- * @uses PMA_List::getDefault() to mark this as selected if requested
- * @uses htmlspecialchars() to escape items
* @param mixed $selected the selected db or true for selecting current db
* @param boolean $include_information_schema
* @return string HTML option tags
@@ -108,7 +98,6 @@ public function getHtmlOptions($selected = '', $include_information_schema = tru
/**
* returns default item
*
- * @uses PMA_List::getEmpty() as fallback
* @return string default item
*/
public function getDefault()
View
49 libraries/List_Database.class.php
@@ -56,10 +56,6 @@
/**
* Constructor
*
- * @uses PMA_List_Database::$_db_link
- * @uses PMA_List_Database::$_db_link_user
- * @uses PMA_List_Database::$_db_link_control
- * @uses PMA_List_Database::build()
* @param mixed $db_link_user user database link resource|object
* @param mixed $db_link_control control database link resource|object
*/
@@ -77,9 +73,6 @@ public function __construct($db_link_user = null, $db_link_control = null)
* checks if the configuration wants to hide some databases
*
* @todo temporaly use this docblock to test how to doc $GLOBALS
- * @uses PMA_List_Database::$items
- * @uses preg_match()
- * @uses $cfg['Server']['hide_db']
*/
protected function _checkHideDatabase()
{
@@ -98,16 +91,6 @@ protected function _checkHideDatabase()
* retrieves database list from server
*
* @todo we could also search mysql tables if all fail?
- * @uses PMA_List_Database::$_show_databases_disabled for not retrying if SHOW DATABASES is disabled
- * @uses PMA_List_Database::$_db_link
- * @uses PMA_List_Database::$_db_link_control in case of SHOW DATABASES is disabled for userlink
- * @uses PMA_DBI_fetch_result()
- * @uses PMA_DBI_getError()
- * @uses natsort()
- * @uses sort()
- * @uses $cfg['NaturalOrder']
- * @uses $GLOBALS['error_showdatabases']
- * @uses $GLOBALS['errno']
* @param string $like_db_name usally a db_name containing wildcards
*/
protected function _retrieve($like_db_name = null)
@@ -160,11 +143,6 @@ protected function _retrieve($like_db_name = null)
/**
* builds up the list
*
- * @uses PMA_List_Database::$items to initialize it
- * @uses PMA_List_Database::_checkOnlyDatabase()
- * @uses PMA_List_Database::_retrieve()
- * @uses PMA_List_Database::_checkHideDatabase()
- * @uses exchangeArray()
*/
public function build()
{
@@ -179,17 +157,6 @@ public function build()
/**
* checks the only_db configuration
*
- * @uses PMA_List_Database::$_show_databases_disabled
- * @uses PMA_List_Database::$items
- * @uses PMA_List_Database::_retrieve()
- * @uses PMA_unescape_mysql_wildcards()
- * @uses preg_match()
- * @uses array_diff()
- * @uses array_merge()
- * @uses is_array()
- * @uses strlen()
- * @uses is_string()
- * @uses $cfg['Server']['only_db']
* @return boolean false if there is no only_db, otherwise true
*/
protected function _checkOnlyDatabase()
@@ -240,9 +207,6 @@ protected function _checkOnlyDatabase()
/**
* returns default item
*
- * @uses PMA_List::getEmpty()
- * @uses $GLOBALS['db']
- * @uses strlen()
* @return string default item
*/
public function getDefault()
@@ -257,18 +221,6 @@ public function getDefault()
/**
* returns array with dbs grouped with extended infos
*
- * @uses $GLOBALS['PMA_List_Database']
- * @uses $GLOBALS['cfgRelation']['commwork']
- * @uses $cfg['ShowTooltip']
- * @uses $cfg['LeftFrameDBTree']
- * @uses $cfg['LeftFrameDBSeparator']
- * @uses $cfg['ShowTooltipAliasDB']
- * @uses PMA_getTableCount()
- * @uses PMA_getDbComment()
- * @uses is_array()
- * @uses implode()
- * @uses strstr()
- * @uses explode()
* @param integer $offset
* @param integer $count
* @return array db list
@@ -347,7 +299,6 @@ public function getGroupedDetails($offset, $count)
/**
* returns a part of the items
*
- * @uses array_slice()
* @param integer $offset
* @param integer $count
* @return array some items
View
87 libraries/Message.class.php
@@ -137,13 +137,6 @@ class PMA_Message
/**
* Constructor
*
- * @uses PMA_Message::setNumber()
- * @uses PMA_Message::setString()
- * @uses PMA_Message::setParams()
- * @uses PMA_Message::NOTICE
- * @uses PMA_Message::SANITIZE_NONE
- * @uses PMA_Message::SANITIZE_STRING
- * @uses PMA_Message::SANITIZE_PARAMS
* @param string $string
* @param integer $number
* @param array $params
@@ -160,7 +153,6 @@ public function __construct($string = '', $number = PMA_Message::NOTICE,
/**
* magic method: return string representation for this object
*
- * @uses PMA_Message::getMessage()
* @return string
*/
public function __toString()
@@ -174,8 +166,6 @@ public function __toString()
* shorthand for getting a simple success message
*
* @static
- * @uses PMA_Message as returned object
- * @uses PMA_Message::SUCCESS
* @param string $string a localized string e.g. __('Your SQL query has been executed successfully')
* @return PMA_Message
*/
@@ -194,8 +184,6 @@ static public function success($string = '')
* shorthand for getting a simple error message
*
* @static
- * @uses PMA_Message as returned object
- * @uses PMA_Message::ERROR
* @param string $string a localized string e.g. __('Error')
* @return PMA_Message
*/
@@ -214,8 +202,6 @@ static public function error($string = '')
* shorthand for getting a simple notice message
*
* @static
- * @uses PMA_Message as returned object
- * @uses PMA_Message::NOTICE
* @param string $string a localized string e.g. __('The additional features for working with linked tables have been deactivated. To find out why click %shere%s.')
* @return PMA_Message
*/
@@ -230,8 +216,6 @@ static public function notice($string)
* shorthand for getting a customized message
*
* @static
- * @uses PMA_Message as returned object
- * @uses PMA_Message::setMessage()
* @param string $message
* @param integer $type
* @return PMA_Message
@@ -249,9 +233,6 @@ static public function raw($message, $type = PMA_Message::NOTICE)
* shorthand for getting a customized message
*
* @static
- * @uses PMA_Message as returned object
- * @uses PMA_Message::success()
- * @uses PMA_Message::addParam()
* @param integer $rows Number of rows
* @return PMA_Message
*/
@@ -268,9 +249,6 @@ static public function affected_rows($rows)
* shorthand for getting a customized message
*
* @static
- * @uses PMA_Message as returned object
- * @uses PMA_Message::success()
- * @uses PMA_Message::addParam()
* @param integer $rows Number of rows
* @return PMA_Message
*/
@@ -287,9 +265,6 @@ static public function deleted_rows($rows)
* shorthand for getting a customized message
*
* @static
- * @uses PMA_Message as returned object
- * @uses PMA_Message::success()
- * @uses PMA_Message::addParam()
* @param integer $rows Number of rows
* @return PMA_Message
*/
@@ -306,8 +281,6 @@ static public function inserted_rows($rows)
* shorthand for getting a customized error message
*
* @static
- * @uses PMA_Message::raw()
- * @uses PMA_Message::ERROR
* @param string $message
* @return PMA_Message
*/
@@ -322,8 +295,6 @@ static public function rawError($message)
* shorthand for getting a customized notice message
*
* @static
- * @uses PMA_Message::raw()
- * @uses PMA_Message::NOTICE
* @param string $message
* @return PMA_Message
*/
@@ -338,8 +309,6 @@ static public function rawNotice($message)
* shorthand for getting a customized success message
*
* @static
- * @uses PMA_Message::raw()
- * @uses PMA_Message::SUCCESS
* @param string $message
* @return PMA_Message
*/
@@ -352,9 +321,6 @@ static public function rawSuccess($message)
* returns whether this message is a success message or not
* and optionaly makes this message a success message
*
- * @uses PMA_Message::SUCCESS
- * @uses PMA_Message::setNumber()
- * @uses PMA_Message::getNumber()
* @param boolean $set
* @return boolean whether this is a success message or not
*/
@@ -371,9 +337,6 @@ public function isSuccess($set = false)
* returns whether this message is a notice message or not
* and optionally makes this message a notice message
*
- * @uses PMA_Message::NOTICE
- * @uses PMA_Message::setNumber()
- * @uses PMA_Message::getNumber()
* @param boolean $set
* @return boolean whether this is a notice message or not
*/
@@ -390,9 +353,6 @@ public function isNotice($set = false)
* returns whether this message is an error message or not
* and optionally makes this message an error message
*
- * @uses PMA_Message::ERROR
- * @uses PMA_Message::setNumber()
- * @uses PMA_Message::getNumber()
* @param boolean $set
* @return boolean whether this is an error message or not
*/
@@ -408,8 +368,6 @@ public function isError($set = false)
/**
* set raw message (overrides string)
*
- * @uses PMA_Message::$_message to set it
- * @uses PMA_Message::sanitize()
* @param string $message
* @param boolean $sanitize whether to sanitize $message or not
*/
@@ -424,8 +382,6 @@ public function setMessage($message, $sanitize = false)
/**
* set string (does not take effect if raw message is set)
*
- * @uses PMA_Message::$_string to set it
- * @uses PMA_Message::sanitize()
* @param string $_string
* @param boolean $sanitize whether to sanitize $string or not
*/
@@ -440,7 +396,6 @@ public function setString($_string, $sanitize = true)
/**
* set message type number
*
- * @uses PMA_Message::$_number to set it
* @param integer $number
*/
public function setNumber($number)
@@ -458,9 +413,6 @@ public function setNumber($number)
* $message->addParam('<img src="img" />', false);
* </code>
*
- * @uses htmlspecialchars()
- * @uses PMA_Message::$_params to fill
- * @uses PMA_Message::notice()
* @param mixed $param
* @param boolean $raw
*/
@@ -478,8 +430,6 @@ public function addParam($param, $raw = true)
/**
* add another string to be concatenated on displaying
*
- * @uses PMA_Message::$_added_messages to fill
- * @uses PMA_Message::notice()
* @param string $string to be added
* @param string $separator to use between this and previous string/message
*/
@@ -492,7 +442,6 @@ public function addString($string, $separator = ' ')
/**
* add a bunch of messages at once
*
- * @uses PMA_Message::addMessage()
* @param array $messages to be added
* @param string $separator to use between this and previous string/message
*/
@@ -506,8 +455,6 @@ public function addMessages($messages, $separator = ' ')
/**
* add another raw message to be concatenated on displaying
*
- * @uses PMA_Message::$_added_messages to fill
- * @uses PMA_Message::rawNotice()
* @param mixed $message to be added
* @param string $separator to use between this and previous string/message
*/
@@ -527,8 +474,6 @@ public function addMessage($message, $separator = ' ')
/**
* set all params at once, usually used in conjunction with string
*
- * @uses PMA_Message::sanitize()
- * @uses PMA_Message::$_params to set
* @param array $params
* @param boolean $sanitize
*/
@@ -543,7 +488,6 @@ public function setParams($params, $sanitize = false)
/**
* return all parameters
*
- * @uses PMA_Message::$_params as return value
* @return array
*/
public function getParams()
@@ -554,7 +498,6 @@ public function getParams()
/**
* return all added messages
*
- * @uses PMA_Message::$_added_messages as return value
* @return array
*/
public function getAddedMessages()
@@ -566,9 +509,6 @@ public function getAddedMessages()
* Sanitizes $message
*
* @static
- * @uses is_array()
- * @uses htmlspecialchars()
- * @uses PMA_Message::sanitize() recursive
* @param mixed $message the message(s)
* @return mixed the sanitized message(s)
* @access public
@@ -591,7 +531,6 @@ static public function sanitize($message)
* for formatting
*
* @static
- * @uses PMA_sanitize
* @param string $message the message
* @return string the decoded message
* @access public
@@ -604,11 +543,6 @@ static public function decodeBB($message)
/**
* wrapper for sprintf()
*
- * @uses sprintf()
- * @uses func_get_args()
- * @uses is_array()
- * @uses array_unshift()
- * @uses call_user_func_array()
* @return string formatted
*/
static public function format()
@@ -625,11 +559,6 @@ static public function format()
/**
* returns unique PMA_Message::$_hash, if not exists it will be created
*
- * @uses PMA_Message::$_hash as return value and to set it if required
- * @uses PMA_Message::getNumber()
- * @uses PMA_Message::$_string
- * @uses PMA_Message::$_message
- * @uses md5()
* @return string PMA_Message::$_hash
*/
public function getHash()
@@ -648,13 +577,6 @@ public function getHash()
/**
* returns compiled message
*
- * @uses PMA_Message::$_message as return value
- * @uses PMA_Message::getString()
- * @uses PMA_Message::getParams()
- * @uses PMA_Message::format()
- * @uses PMA_Message::decodeBB()
- * @uses PMA_Message::getAddedMessages()
- * @uses strlen()
* @return string complete message
*/
public function getMessage()
@@ -688,7 +610,6 @@ public function getMessage()
/**
* returns PMA_Message::$_string
*
- * @uses PMA_Message::$_string as return value
* @return string PMA_Message::$_string
*/
public function getString()
@@ -699,7 +620,6 @@ public function getString()
/**
* returns PMA_Message::$_number
*
- * @uses PMA_Message::$_number as return value
* @return integer PMA_Message::$_number
*/
public function getNumber()
@@ -710,8 +630,6 @@ public function getNumber()
/**
* returns level of message
*
- * @uses PMA_Message::$level
- * @uses PMA_Message::getNumber()
* @return string level of message
*/
public function getLevel()
@@ -722,8 +640,6 @@ public function getLevel()
/**
* Displays the message in HTML
*
- * @uses PMA_Message::getDisplay()
- * @uses PMA_Message::isDisplayed()
*/
public function display()
{
@@ -734,8 +650,6 @@ public function display()
/**
* returns HTML code for displaying this message
*
- * @uses PMA_Message::getLevel()
- * @uses PMA_Message::getMessage()
*
* @return string whole message box
*/
@@ -748,7 +662,6 @@ public function getDisplay()
/**
* sets and returns whether the message was displayed or not
*
- * @uses PMA_Message::$_is_displayed to set it and/or return it
* @param boolean $is_displayed
* @return boolean PMA_Message::$_is_displayed
*/
View
4 libraries/PMA.php
@@ -82,10 +82,6 @@ public function __set($param, $value)
/**
* Accessor to PMA::$databases
*
- * @uses PMA::$databases
- * @uses PMA::$userlink
- * @uses PMA::$controllink
- * @uses PMA_List_Database
* @return PMA_List_Databases
*/
public function getDatabaseList()
View
2 libraries/Partition.class.php
@@ -17,7 +17,6 @@ class PMA_Partition
* returns array of partition names for a specific db/table
*
* @access public
- * @uses PMA_DBI_fetch_result()
* @return array of partition names
*/
static public function getPartitionNames($db, $table)
@@ -36,7 +35,6 @@ static public function getPartitionNames($db, $table)
* @staticvar boolean $have_partitioning
* @staticvar boolean $already_checked
* @access public
- * @uses PMA_DBI_fetch_result()
* @return boolean
*/
static public function havePartitioning()
View
7 libraries/RecentTable.class.php
@@ -70,10 +70,6 @@ public static function getInstance()
/**
* Returns recently used tables from phpMyAdmin database.
*
- * @uses $pma_table
- * @uses PMA_query_as_controluser()
- * @uses PMA_DBI_fetch_array()
- * @uses json_decode()
*
* @return array
*/
@@ -95,9 +91,6 @@ public function getFromDb()
/**
* Save recent tables into phpMyAdmin database.
*
- * @uses PMA_DBI_try_query()
- * @uses json_decode()
- * @uses PMA_Message
*
* @return true|PMA_Message
*/
View
39 libraries/StorageEngine.class.php
@@ -51,7 +51,6 @@ class PMA_StorageEngine
* @static
* @staticvar array $storage_engines storage engines
* @access public
- * @uses PMA_DBI_fetch_result()
* @return array of storage engines
*/
static public function getStorageEngines()
@@ -69,9 +68,6 @@ static public function getStorageEngines()
* returns HTML code for storage engine select box
*
* @static
- * @uses PMA_StorageEngine::getStorageEngines()
- * @uses strtolower()
- * @uses htmlspecialchars()
* @param string $name The name of the select form element
* @param string $id The ID of the form field
* @param string $selected The selected engine
@@ -110,9 +106,6 @@ static public function getHtmlSelect($name = 'engine', $id = null,
*
* Loads the corresponding engine plugin, if available.
*
- * @uses str_replace()
- * @uses file_exists()
- * @uses PMA_StorageEngine
* @param string $engine The engine ID
* @return object The engine plugin
*/
@@ -134,7 +127,6 @@ static public function getEngine($engine)
* return true if given engine name is supported/valid, otherwise false
*
* @static
- * @uses PMA_StorageEngine::getStorageEngines()
* @param string $engine name of engine
* @return boolean whether $engine is valid or not
*/
@@ -150,13 +142,6 @@ static public function isValid($engine)
/**
* returns as HTML table of the engine's server variables
*
- * @uses PMA_ENGINE_DETAILS_TYPE_SIZE
- * @uses PMA_ENGINE_DETAILS_TYPE_NUMERIC
- * @uses PMA_StorageEngine::getVariablesStatus()
- * @uses PMA_showHint()
- * @uses PMA_formatByteDown()
- * @uses PMA_formatNumber()
- * @uses htmlspecialchars()
* @return string The table that was generated based on the retrieved information
*/
function getHtmlVariables()
@@ -219,12 +204,6 @@ function resolveTypeSize($value)
/**
* returns array with detailed info about engine specific server variables
*
- * @uses PMA_ENGINE_DETAILS_TYPE_PLAINTEXT
- * @uses PMA_StorageEngine::getVariables()
- * @uses PMA_StorageEngine::getVariablesLikePattern()
- * @uses PMA_DBI_query()
- * @uses PMA_DBI_fetch_assoc()
- * @uses PMA_DBI_free_result()
* @return array with detailed info about specific engine server variables
*/
function getVariablesStatus()
@@ -269,15 +248,6 @@ function engine_init() {}
/**
* Constructor
*
- * @uses PMA_StorageEngine::getStorageEngines()
- * @uses PMA_ENGINE_SUPPORT_DEFAULT
- * @uses PMA_ENGINE_SUPPORT_YES
- * @uses PMA_ENGINE_SUPPORT_DISABLED
- * @uses PMA_ENGINE_SUPPORT_NO
- * @uses $this->engine
- * @uses $this->title
- * @uses $this->comment
- * @uses $this->support
* @param string $engine The engine ID
*/
function __construct($engine)
@@ -313,7 +283,6 @@ function __construct($engine)
* public String getTitle()
*
* Reveals the engine's title
- * @uses $this->title
* @return string The title
*/
function getTitle()
@@ -325,7 +294,6 @@ function getTitle()
* public String getComment()
*
* Fetches the server's comment about this engine
- * @uses $this->comment
* @return string The comment
*/
function getComment()
@@ -336,13 +304,6 @@ function getComment()
/**
* public String getSupportInformationMessage()
*
- * @uses PMA_ENGINE_SUPPORT_DEFAULT
- * @uses PMA_ENGINE_SUPPORT_YES
- * @uses PMA_ENGINE_SUPPORT_DISABLED
- * @uses PMA_ENGINE_SUPPORT_NO
- * @uses $this->support
- * @uses $this->title
- * @uses sprintf
* @return string The localized message.
*/
function getSupportInformationMessage()
View
14 libraries/Table.class.php
@@ -92,7 +92,6 @@ function getLastMessage()
/**
* sets table name
*
- * @uses $this->name to set it
* @param string $table_name new table name
*/
function setName($table_name)
@@ -103,7 +102,6 @@ function setName($table_name)
/**
* returns table name
*
- * @uses $this->name as return value
* @param boolean whether to quote name with backticks ``
* @return string table name
*/
@@ -118,7 +116,6 @@ function getName($backquoted = false)
/**
* sets database name for this table
*
- * @uses $this->db_name to set it
* @param string $db_name
*/
function setDbName($db_name)
@@ -129,7 +126,6 @@ function setDbName($db_name)
/**
* returns database name for this table
*
- * @uses $this->db_name as return value
* @param boolean whether to quote name with backticks ``
* @return string database name for this table
*/
@@ -167,7 +163,6 @@ static public function isView($db = null, $table = null)
/**
* sets given $value for given $param
*
- * @uses $this->settings to add or change value
* @param string param name
* @param mixed param value
*/
@@ -179,7 +174,6 @@ function set($param, $value)
/**
* returns value for given setting/param
*
- * @uses $this->settings to return value
* @param string name for value to return
* @return mixed value for $param
*/
@@ -1220,9 +1214,6 @@ public function getColumns($backquoted = true)
/**
* Return UI preferences for this table from phpMyAdmin database.
*
- * @uses PMA_query_as_controluser()
- * @uses PMA_DBI_fetch_array()
- * @uses json_decode()
*
* @return array
*/
@@ -1249,9 +1240,6 @@ protected function getUiPrefsFromDb()
/**
* Save this table's UI preferences into phpMyAdmin database.
*
- * @uses PMA_DBI_try_query()
- * @uses json_decode()
- * @uses PMA_Message
*
* @return true|PMA_Message
*/
@@ -1282,7 +1270,6 @@ protected function saveUiPrefsToDb()
* If pmadb and table_uiprefs is set, it will load the UI preferences from
* phpMyAdmin database.
*
- * @uses getUiPrefsFromDb()
*/
protected function loadUiPrefs()
{
@@ -1305,7 +1292,6 @@ protected function loadUiPrefs()
* - PROP_SORTED_COLUMN
* - PROP_COLUMN_ORDER
*
- * @uses loadUiPrefs()
*
* @param string $property
* @return mixed
View
44 libraries/Theme.class.php
@@ -69,13 +69,6 @@ class PMA_Theme {
/**
* @access public
- * @uses PMA_Theme::getPath()
- * @uses PMA_Theme::$mtime_info
- * @uses PMA_Theme::setVersion()
- * @uses PMA_Theme::setName()
- * @uses filemtime()
- * @uses filesize()
- * @uses file_exists()
* @return boolean whether loading them info was successful or not
*/
function loadInfo()
@@ -114,10 +107,6 @@ function loadInfo()
*
* @static
* @access public
- * @uses PMA_Theme
- * @uses PMA_Theme::setPath()
- * @uses PMA_Theme::loadInfo()
- * @uses PMA_Theme::checkImgPath()
* @param string $folder path to theme
* @return object PMA_Theme
*/
@@ -140,12 +129,6 @@ static public function load($folder)
* checks image path for existance - if not found use img from original theme
*
* @access public
- * @uses PMA_Theme::getPath()
- * @uses PMA_Theme::setImgPath()
- * @uses PMA_Theme::getName()
- * @uses $GLOBALS['cfg']['ThemePath']
- * @uses is_dir()
- * @uses sprintf()
*/
function checkImgPath()
{
@@ -167,7 +150,6 @@ function checkImgPath()
* returns path to theme
*
* @access public
- * @uses PMA_Theme::$path as return value
* @return string $path path to theme
*/
function getPath()
@@ -179,7 +161,6 @@ function getPath()
* returns layout file
*
* @access public
- * @uses PMA_Theme::getPath()
* @return string layout file
*/
function getLayoutFile()
@@ -191,7 +172,6 @@ function getLayoutFile()
* set path to theme
*
* @access public
- * @uses PMA_Theme::$path to set it
* @param string $path path to theme
*/
function setPath($path)
@@ -203,7 +183,6 @@ function setPath($path)
* sets version
*
* @access public
- * @uses PMA_Theme::$version
* @param string new version
*/
function setVersion($version)
@@ -215,7 +194,6 @@ function setVersion($version)
* returns version
*
* @access public
- * @uses PMA_Theme::$version
* @return string version
*/
function getVersion()
@@ -228,8 +206,6 @@ function getVersion()
* returns true if theme version is equal or higher to $version
*
* @access public
- * @uses version_compare()
- * @uses PMA_Theme::getVersion()
* @param string $version version to compare to
* @return boolean
*/
@@ -242,8 +218,6 @@ function checkVersion($version)
* sets name
*
* @access public