Skip to content

Commit

Permalink
Remove @uses tags from docblocks
Browse files Browse the repository at this point in the history
  • Loading branch information
@nijel
nijel committed Jun 27, 2011
1 parent 327b3d1 commit e57f27e
Show file tree
Hide file tree
Showing 71 changed files with 0 additions and 2,047 deletions.
4 changes: 0 additions & 4 deletions db_export.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/

Expand Down
25 changes: 0 additions & 25 deletions db_search.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/

Expand Down Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion import.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
/**
* Core script for import, this is just the glue around all other stuff
*
* @uses PMA_Bookmark_getList()
* @package phpMyAdmin
*/

Expand Down
19 changes: 0 additions & 19 deletions index.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/

Expand Down
44 changes: 0 additions & 44 deletions libraries/Config.class.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down Expand Up @@ -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()
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
*/
Expand Down Expand Up @@ -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()
{
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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()
*/
Expand All @@ -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
Expand Down
55 changes: 0 additions & 55 deletions libraries/Error.class.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)
Expand All @@ -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)
Expand All @@ -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)
Expand All @@ -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
*/
Expand All @@ -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()
Expand All @@ -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()
Expand All @@ -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()
Expand All @@ -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()
Expand All @@ -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()
Expand All @@ -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()
Expand All @@ -255,8 +228,6 @@ public function getHtmlTitle()
/**
* returns title for error
*
* @uses PMA_Error::getType()
* @uses PMA_Error::getMessage()
* @return string
*/
public function getTitle()
Expand All @@ -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()
{
Expand Down Expand Up @@ -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
*/
Expand All @@ -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()
{
Expand All @@ -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()
Expand All @@ -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
*/
Expand Down
Loading

0 comments on commit e57f27e

Please sign in to comment.