diff --git a/PMAStandard/Sniffs/Commenting/FileCommentSniff.php b/PMAStandard/Sniffs/Commenting/FileCommentSniff.php index 2fbfd4e5c7..fcca9928bd 100644 --- a/PMAStandard/Sniffs/Commenting/FileCommentSniff.php +++ b/PMAStandard/Sniffs/Commenting/FileCommentSniff.php @@ -493,7 +493,7 @@ class PMAStandard_Sniffs_Commenting_FileCommentSniff implements PHP_CodeSniffer_ * @param PHP_CodeSniffer_CommentParser_DocElement $tagElement The doc comment * element. * - * @return void + * @return string|int */ protected function getIndentation($tagName, $tagElement) { diff --git a/gis_data_editor.php b/gis_data_editor.php index 4eb7dd165c..621dbfa9aa 100644 --- a/gis_data_editor.php +++ b/gis_data_editor.php @@ -12,7 +12,7 @@ * * @param string $variable variable to be escaped * - * @return escaped variable + * @return string escaped variable */ function escape($variable) { diff --git a/libraries/Advisor.class.php b/libraries/Advisor.class.php index 30af4770d9..4c96108387 100644 --- a/libraries/Advisor.class.php +++ b/libraries/Advisor.class.php @@ -264,7 +264,7 @@ class Advisor * * @param array $matches List of matched elements form preg_replace_callback * - * @return String Replacement value + * @return string Replacement value */ private function _replaceLinkURL($matches) { @@ -276,7 +276,7 @@ class Advisor * * @param array $matches List of matched elements form preg_replace_callback * - * @return String Replacement value + * @return string Replacement value */ private function _ruleExprEvaluateFired($matches) { @@ -300,7 +300,7 @@ class Advisor * * @param array $matches List of matched elements form preg_replace_callback * - * @return String Replacement value + * @return string Replacement value */ private function _ruleExprEvaluateVariable($matches) { @@ -324,6 +324,8 @@ class Advisor * whole expr * * @return string result of evaluated expression + * + * @throws Exception */ function ruleExprEvaluate($expr, $ignoreUntil = 0) { diff --git a/libraries/DatabaseInterface.class.php b/libraries/DatabaseInterface.class.php index 50347f9d50..51b3cf2ae1 100644 --- a/libraries/DatabaseInterface.class.php +++ b/libraries/DatabaseInterface.class.php @@ -41,7 +41,7 @@ class PMA_DatabaseInterface /** * Constructor * - * @param object $ext PMA_DBI_Extension object to be used for database queries + * @param PMA_DBI_Extension $ext Object to be used for database queries */ public function __construct(PMA_DBI_Extension $ext) { diff --git a/libraries/DisplayResults.class.php b/libraries/DisplayResults.class.php index 6e6e9f2f0a..261ee5792b 100644 --- a/libraries/DisplayResults.class.php +++ b/libraries/DisplayResults.class.php @@ -274,28 +274,28 @@ class PMA_DisplayResults /** * Set properties which were not initialized at the constructor * - * @param type $unlim_num_rows integer the total number of rows returned by + * @param integer $unlim_num_rows the total number of rows returned by * the SQL query without any appended * "LIMIT" clause programmatically - * @param type $fields_meta array meta information about fields - * @param type $is_count boolean - * @param type $is_export integer - * @param type $is_func boolean - * @param type $is_analyse integer - * @param type $num_rows integer total no. of rows returned by SQL query - * @param type $fields_cnt integer total no.of fields returned by SQL query - * @param type $querytime double time taken for execute the SQL query - * @param type $pmaThemeImage string path for theme images directory - * @param type $text_dir string - * @param type $is_maint boolean - * @param type $is_explain boolean - * @param type $is_show boolean - * @param type $showtable array table definitions - * @param type $printview string - * @param type $url_query string URL query - * @param type $editable boolean whether the resutls set is editable + * @param array $fields_meta meta information about fields + * @param boolean $is_count + * @param integer $is_export + * @param boolean $is_func + * @param integer $is_analyse + * @param integer $num_rows total no. of rows returned by SQL query + * @param integer $fields_cnt total no.of fields returned by SQL query + * @param double $querytime time taken for execute the SQL query + * @param string $pmaThemeImage path for theme images directory + * @param string $text_dir + * @param boolean $is_maint + * @param boolean $is_explain + * @param boolean $is_show + * @param array $showtable table definitions + * @param string $printview + * @param string $url_query URL query + * @param boolean $editable whether the results set is editable * - * @return void + * @return void * * @see sql.php */ @@ -979,12 +979,12 @@ class PMA_DisplayResults /** * Get the headers of the results table * - * @param array &$is_display which elements to display - * @param array $analyzed_sql the analyzed query - * @param string $sort_expression sort expression - * @param string $sort_expression_nodirection sort expression without direction - * @param string $sort_direction sort direction - * @param boolean $is_limited_display with limited operations or not + * @param array &$is_display which elements to display + * @param array|string $analyzed_sql the analyzed query + * @param string $sort_expression sort expression + * @param string $sort_expression_nodirection sort expression without direction + * @param string $sort_direction sort direction + * @param boolean $is_limited_display with limited operations or not * * @return string html content * diff --git a/libraries/PDF.class.php b/libraries/PDF.class.php index e0c2344b12..026a87f707 100644 --- a/libraries/PDF.class.php +++ b/libraries/PDF.class.php @@ -38,7 +38,6 @@ class PMA_PDF extends TCPDF * temporary data on filesystem (slower). * @param boolean $pdfa If TRUE set the document to PDF/A mode. * - * @return void * @access public */ public function __construct($orientation = 'P', $unit = 'mm', $format = 'A4', diff --git a/libraries/Util.class.php b/libraries/Util.class.php index 21b61b4cc3..b6c64afa1c 100644 --- a/libraries/Util.class.php +++ b/libraries/Util.class.php @@ -2914,7 +2914,7 @@ class PMA_Util * function because in PHP, decbin() supports only 32 bits * on 32-bit servers * - * @param numeric $value coming from a BIT field + * @param number $value coming from a BIT field * @param integer $length length * * @return string the printable value @@ -3917,7 +3917,7 @@ class PMA_Util * * @param string $limit_clause limit clause * - * @return array Start and length attributes of the limit clause + * @return array|void Start and length attributes of the limit clause */ public static function analyzeLimitClause($limit_clause) { diff --git a/libraries/bookmark.lib.php b/libraries/bookmark.lib.php index 0c9ff69a76..10adc2e107 100644 --- a/libraries/bookmark.lib.php +++ b/libraries/bookmark.lib.php @@ -49,7 +49,7 @@ function PMA_Bookmark_getParams() * * @access public * - * @global resource the controluser db connection handle + * @global resource $controllink the controluser db connection handle */ function PMA_Bookmark_getList($db) { @@ -105,7 +105,7 @@ function PMA_Bookmark_getList($db) * * @access public * - * @global resource the controluser db connection handle + * @global resource $controllink the controluser db connection handle * */ function PMA_Bookmark_get($db, $id, $id_field = 'id', $action_bookmark_all = false, @@ -148,7 +148,7 @@ function PMA_Bookmark_get($db, $id, $id_field = 'id', $action_bookmark_all = fal * * @access public * - * @global resource the controluser db connection handle + * @global resource $controllink the controluser db connection handle */ function PMA_Bookmark_save($bkm_fields, $all_users = false) { @@ -186,7 +186,7 @@ function PMA_Bookmark_save($bkm_fields, $all_users = false) * * @access public * - * @global resource the controluser db connection handle + * @global resource $controllink the controluser db connection handle */ function PMA_Bookmark_delete($db, $id) { diff --git a/libraries/core.lib.php b/libraries/core.lib.php index d27788d333..cea490f1dd 100644 --- a/libraries/core.lib.php +++ b/libraries/core.lib.php @@ -201,7 +201,7 @@ function PMA_securePath($path) * @param string|array $message_args arguments applied to $error_message * @param boolean $delete_session whether to delete session cookie * - * @return exit + * @return void */ function PMA_fatalError( $error_message, $message_args = null, $delete_session = true diff --git a/libraries/dbi/DBIDummy.class.php b/libraries/dbi/DBIDummy.class.php index d2d7a6a987..c7ad6fb129 100644 --- a/libraries/dbi/DBIDummy.class.php +++ b/libraries/dbi/DBIDummy.class.php @@ -693,7 +693,7 @@ class PMA_DBI_Dummy implements PMA_DBI_Extension * * @param object $link the connection object * - * @return bool false + * @return boolean false */ public function nextResult($link = null) { diff --git a/libraries/dbi/DBIExtension.int.php b/libraries/dbi/DBIExtension.int.php index 2511e432f1..0e6ec3fea6 100644 --- a/libraries/dbi/DBIExtension.int.php +++ b/libraries/dbi/DBIExtension.int.php @@ -49,7 +49,7 @@ interface PMA_DBI_Extension * @param object $link connection object * @param int $options query options * - * @return result object|bool + * @return object|bool result */ public function realQuery($query, $link, $options); @@ -121,7 +121,7 @@ interface PMA_DBI_Extension /** * Prepare next result from multi_query * - * @param objecy $link the connection object + * @param object $link the connection object * * @return bool true or false */ diff --git a/libraries/dbi/DBIMysql.class.php b/libraries/dbi/DBIMysql.class.php index 7868245fb7..d67c64b90f 100644 --- a/libraries/dbi/DBIMysql.class.php +++ b/libraries/dbi/DBIMysql.class.php @@ -315,7 +315,7 @@ class PMA_DBI_Mysql implements PMA_DBI_Extension * * @param object $link the connection object * - * @return bool false + * @return boolean false */ public function nextResult($link = null) { diff --git a/libraries/dbi/drizzle-wrappers.lib.php b/libraries/dbi/drizzle-wrappers.lib.php index ba560f71f9..a712e7d35c 100644 --- a/libraries/dbi/drizzle-wrappers.lib.php +++ b/libraries/dbi/drizzle-wrappers.lib.php @@ -133,8 +133,6 @@ class PMA_DrizzleCon * Constructor * * @param DrizzleCon $dcon connection handle - * - * @return void */ public function __construct(DrizzleCon $dcon) { diff --git a/libraries/display_export.lib.php b/libraries/display_export.lib.php index e3fecb5fe4..20d0820ce6 100644 --- a/libraries/display_export.lib.php +++ b/libraries/display_export.lib.php @@ -17,7 +17,7 @@ if (! defined('PHPMYADMIN')) { * * @param string $str option name * - * @return void + * @return string|void */ function PMA_exportCheckboxCheck($str) { diff --git a/libraries/display_select_lang.lib.php b/libraries/display_select_lang.lib.php index bab89e829a..0ff4c86cc4 100644 --- a/libraries/display_select_lang.lib.php +++ b/libraries/display_select_lang.lib.php @@ -16,7 +16,7 @@ if (! defined('PHPMYADMIN')) { * @param array $a The first language being compared * @param array $b The second language being compared * - * @return the sorted array + * @return int the sorted array */ function PMA_languageCmp($a, $b) { diff --git a/libraries/engines/pbxt.lib.php b/libraries/engines/pbxt.lib.php index 9da930c36a..4b7bcf92db 100644 --- a/libraries/engines/pbxt.lib.php +++ b/libraries/engines/pbxt.lib.php @@ -106,6 +106,11 @@ class PMA_StorageEngine_pbxt extends PMA_StorageEngine } //-------------------- + /** + * Get information about pages + * + * @return array Information about pages + */ function getInfoPages() { $pages = array(); @@ -114,6 +119,13 @@ class PMA_StorageEngine_pbxt extends PMA_StorageEngine } //-------------------- + /** + * Get content of a page + * + * @param string $id Id of searched page + * + * @return string + */ function getPage($id) { if (! array_key_exists($id, $this->getInfoPages())) { @@ -125,6 +137,11 @@ class PMA_StorageEngine_pbxt extends PMA_StorageEngine return $this->$id(); } + /** + * Get content of documentation page + * + * @return string + */ function getPageDocumentation() { $output = '
' . sprintf( diff --git a/libraries/file_listing.lib.php b/libraries/file_listing.lib.php index fbeed49763..2c457ef1c5 100644 --- a/libraries/file_listing.lib.php +++ b/libraries/file_listing.lib.php @@ -68,7 +68,7 @@ function PMA_getFileSelectOptions($dir, $extensions = '', $active = '') /** * Get currently supported decompressions. * - * @return string | separated list of extensions usable in PMA_getDirContent + * @return string separated list of extensions usable in PMA_getDirContent */ function PMA_supportedDecompressions() { diff --git a/libraries/gis/pma_gis_geometrycollection.php b/libraries/gis/pma_gis_geometrycollection.php index 0a770971a3..5233c91103 100644 --- a/libraries/gis/pma_gis_geometrycollection.php +++ b/libraries/gis/pma_gis_geometrycollection.php @@ -32,7 +32,7 @@ class PMA_GIS_Geometrycollection extends PMA_GIS_Geometry /** * Returns the singleton. * - * @return the singleton + * @return PMA_GIS_Geometrycollection the singleton * @access public */ public static function singleton() diff --git a/libraries/gis/pma_gis_multilinestring.php b/libraries/gis/pma_gis_multilinestring.php index ce4a0c94a1..7bd00d602c 100644 --- a/libraries/gis/pma_gis_multilinestring.php +++ b/libraries/gis/pma_gis_multilinestring.php @@ -328,8 +328,8 @@ class PMA_GIS_Multilinestring extends PMA_GIS_Geometry /** * Generate parameters for the GIS data editor from the value of the GIS column. * - * @param string $value of the GIS column - * @param index $index of the geometry + * @param string $value Value of the GIS column + * @param int $index Index of the geometry * * @return array params for the GIS data editor from the value of the GIS column * @access public diff --git a/libraries/gis/pma_gis_multipoint.php b/libraries/gis/pma_gis_multipoint.php index e6b7ef71ad..478825f7d5 100644 --- a/libraries/gis/pma_gis_multipoint.php +++ b/libraries/gis/pma_gis_multipoint.php @@ -281,8 +281,8 @@ class PMA_GIS_Multipoint extends PMA_GIS_Geometry /** * Generate parameters for the GIS data editor from the value of the GIS column. * - * @param string $value of the GIS column - * @param index $index of the geometry + * @param string $value Value of the GIS column + * @param integer $index Index of the geometry * * @return array params for the GIS data editor from the value of the GIS column * @access public diff --git a/libraries/gis/pma_gis_multipolygon.php b/libraries/gis/pma_gis_multipolygon.php index a8c8241524..3d55417c22 100644 --- a/libraries/gis/pma_gis_multipolygon.php +++ b/libraries/gis/pma_gis_multipolygon.php @@ -464,8 +464,8 @@ class PMA_GIS_Multipolygon extends PMA_GIS_Geometry /** * Generate parameters for the GIS data editor from the value of the GIS column. * - * @param string $value of the GIS column - * @param index $index of the geometry + * @param string $value Value of the GIS column + * @param int $index Index of the geometry * * @return array params for the GIS data editor from the value of the GIS column * @access public diff --git a/libraries/gis/pma_gis_point.php b/libraries/gis/pma_gis_point.php index e1e4d23708..27e0ed47e3 100644 --- a/libraries/gis/pma_gis_point.php +++ b/libraries/gis/pma_gis_point.php @@ -263,7 +263,7 @@ class PMA_GIS_Point extends PMA_GIS_Geometry * Generate parameters for the GIS data editor from the value of the GIS column. * * @param string $value of the GIS column - * @param index $index of the geometry + * @param int $index of the geometry * * @return array params for the GIS data editor from the value of the GIS column * @access public diff --git a/libraries/gis/pma_gis_polygon.php b/libraries/gis/pma_gis_polygon.php index 47dde132fb..f7396b7a07 100644 --- a/libraries/gis/pma_gis_polygon.php +++ b/libraries/gis/pma_gis_polygon.php @@ -445,7 +445,7 @@ class PMA_GIS_Polygon extends PMA_GIS_Geometry * * @param array $ring array of points forming the ring * - * @return array a point on the surface of the ring + * @return array|void a point on the surface of the ring * @access public * @static */ @@ -507,8 +507,8 @@ class PMA_GIS_Polygon extends PMA_GIS_Geometry /** Generate parameters for the GIS data editor from the value of the GIS column. * - * @param string $value of the GIS column - * @param index $index of the geometry + * @param string $value Value of the GIS column + * @param int $index Index of the geometry * * @return array params for the GIS data editor from the value of the GIS column * @access public diff --git a/libraries/insert_edit.lib.php b/libraries/insert_edit.lib.php index 4b74d61713..146c0431e4 100644 --- a/libraries/insert_edit.lib.php +++ b/libraries/insert_edit.lib.php @@ -47,7 +47,7 @@ function PMA_getFormParametersForInsertForm($db, $table, $where_clauses, * * @param array $where_clause where clause * - * @return whereClauseArray array of where clauses + * @return array|void whereClauseArray array of where clauses */ function PMA_getWhereClauseArray($where_clause) { @@ -854,7 +854,7 @@ function PMA_getTextarea($column, $backup_field, $column_name_appendix, * @param type $idindex id index * @param type $data data to edit * - * @return type string an html snippet + * @return string an html snippet */ function PMA_getPmaTypeEnum($column, $backup_field, $column_name_appendix, $extracted_columnspec, $unnullify_trigger, $tabindex, $tabindex_for_value, @@ -1220,7 +1220,7 @@ function PMA_getHTMLinput($column, $column_name_appendix, $special_chars, * @param string $vkey [multi_edit]['row_id'] * @param array $column description of column in given table * - * @return string an html snippet + * @return string|void an html snippet */ function PMA_getSelectOptionForUpload($vkey, $column) { @@ -1283,7 +1283,7 @@ function PMA_getMaxUploadSize($column, $biggest_max_file_size) } /** - * Get HTML for the Value column of other datatypes + * Get HTML for the Value column of other datatypes * (here, "column" is used in the sense of HTML column in HTML table) * * @param array $column description of column in given table diff --git a/libraries/kanji-encoding.lib.php b/libraries/kanji-encoding.lib.php index a6fc32034f..0495112b79 100644 --- a/libraries/kanji-encoding.lib.php +++ b/libraries/kanji-encoding.lib.php @@ -20,7 +20,7 @@ if (! defined('PHPMYADMIN')) { * codes list * 2002/1/4 by Y.Kawada * - * @global string the available encoding codes list + * @global string $kanji_encoding_list the available encoding codes list * * @return boolean always true */ @@ -43,7 +43,7 @@ function PMA_Kanji_checkEncoding() * Reverses SJIS & EUC-JP position in the encoding codes list * 2002/1/4 by Y.Kawada * - * @global string the available encoding codes list + * @global string $kanji_encoding_list the available encoding codes list * * @return boolean always true */ @@ -70,7 +70,7 @@ function PMA_Kanji_changeOrder() * @param string $enc the destination encoding code * @param string $kana set 'kana' convert to JIS-X208-kana * - * @global string the available encoding codes list + * @global string $kanji_encoding_list the available encoding codes list * * @return string the converted string */ diff --git a/libraries/mysql_charsets.lib.php b/libraries/mysql_charsets.lib.php index 31376c7648..3a88ec0661 100644 --- a/libraries/mysql_charsets.lib.php +++ b/libraries/mysql_charsets.lib.php @@ -69,6 +69,13 @@ function PMA_generateCharsetDropdownBox($type = PMA_CSDROPDOWN_COLLATION, return $return_str; } +/** + * Generate the charset query part + * + * @param string $collation Collation + * + * @return string + */ function PMA_generateCharsetQueryPart($collation) { if (!PMA_DRIZZLE) { diff --git a/libraries/plugin_interface.lib.php b/libraries/plugin_interface.lib.php index 486f037a48..be7e593db4 100644 --- a/libraries/plugin_interface.lib.php +++ b/libraries/plugin_interface.lib.php @@ -15,7 +15,7 @@ * @param mixed $plugin_param parameter to plugin by which they can * decide whether they can work * - * @return new plugin instance + * @return object|null new plugin instance */ function PMA_getPlugin( $plugin_type, diff --git a/libraries/plugins/PluginManager.class.php b/libraries/plugins/PluginManager.class.php index 8eac3fd20b..3485981944 100644 --- a/libraries/plugins/PluginManager.class.php +++ b/libraries/plugins/PluginManager.class.php @@ -120,7 +120,7 @@ class PluginManager implements SplSubject * If a plugin changes its status, this has to be remembered in order to * notify the rest of the plugins that they should update * - * @param mixed $_status contains information about the current plugin state + * @param string $_status contains information about the current plugin state * * @return void */ diff --git a/libraries/plugins/auth/AuthenticationHttp.class.php b/libraries/plugins/auth/AuthenticationHttp.class.php index d079cc8381..75273b11aa 100644 --- a/libraries/plugins/auth/AuthenticationHttp.class.php +++ b/libraries/plugins/auth/AuthenticationHttp.class.php @@ -95,17 +95,19 @@ class AuthenticationHttp extends AuthenticationPlugin /** * Gets advanced authentication settings * - * @global string the username if register_globals is on - * @global string the password if register_globals is on - * @global array the array of server variables if register_globals is - * off - * @global array the array of environment variables if register_globals - * is off - * @global string the username for the ? server - * @global string the password for the ? server - * @global string the username for the WebSite Professional server - * @global string the password for the WebSite Professional server - * @global string the username of the user who logs out + * @global string $PHP_AUTH_USER the username if register_globals is on + * @global string $PHP_AUTH_PW the password if register_globals is on + * @global array the array of server variables if + * register_globals is off + * @global array the array of environment variables if + * register_globals is off + * @global string the username for the ? server + * @global string the password for the ? server + * @global string the username for the WebSite Professional + * server + * @global string the password for the WebSite Professional + * server + * @global string the username of the user who logs out * * @return boolean whether we get authentication settings or not */ @@ -189,11 +191,11 @@ class AuthenticationHttp extends AuthenticationPlugin /** * Set the user and password after last checkings if required * - * @global array the valid servers settings - * @global integer the id of the current server - * @global array the current server settings - * @global string the current username - * @global string the current password + * @global array $cfg the valid servers settings + * @global integer $server the id of the current server + * @global array the current server settings + * @global string $PHP_AUTH_USER the current username + * @global string $PHP_AUTH_PW the current password * * @return boolean always true */ diff --git a/libraries/plugins/auth/AuthenticationSignon.class.php b/libraries/plugins/auth/AuthenticationSignon.class.php index a3d6cb9d0e..4586af92b0 100644 --- a/libraries/plugins/auth/AuthenticationSignon.class.php +++ b/libraries/plugins/auth/AuthenticationSignon.class.php @@ -53,17 +53,17 @@ class AuthenticationSignon extends AuthenticationPlugin /** * Gets advanced authentication settings * - * @global string the username if register_globals is on - * @global string the password if register_globals is on - * @global array the array of server variables if register_globals is - * off - * @global array the array of environment variables if register_globals - * is off - * @global string the username for the ? server - * @global string the password for the ? server - * @global string the username for the WebSite Professional server - * @global string the password for the WebSite Professional server - * @global string the username of the user who logs out + * @global string $PHP_AUTH_USER the username if register_globals is on + * @global string $PHP_AUTH_PW the password if register_globals is on + * @global array the array of server variables if + * register_globals is off + * @global array the array of environment variables if + * register_globals is off + * @global string the username for the ? server + * @global string the password for the ? server + * @global string the username for the WebSite Professional server + * @global string the password for the WebSite Professional server + * @global string the username of the user who logs out * * @return boolean whether we get authentication settings or not */ @@ -215,11 +215,11 @@ class AuthenticationSignon extends AuthenticationPlugin /** * Set the user and password after last checkings if required * - * @global array the valid servers settings - * @global integer the id of the current server - * @global array the current server settings - * @global string the current username - * @global string the current password + * @global array $cfg the valid servers settings + * @global integer the id of the current server + * @global array the current server settings + * @global string $PHP_AUTH_USER the current username + * @global string $PHP_AUTH_PW the current password * * @return boolean always true */ diff --git a/libraries/plugins/export/ExportXml.class.php b/libraries/plugins/export/ExportXml.class.php index d246b1230f..e36b1103e2 100644 --- a/libraries/plugins/export/ExportXml.class.php +++ b/libraries/plugins/export/ExportXml.class.php @@ -502,7 +502,7 @@ class ExportXml extends ExportPlugin /** * Gets the table name * - * @return void + * @return string */ private function _getTable() { diff --git a/libraries/plugins/export/PMA_ExportPdf.class.php b/libraries/plugins/export/PMA_ExportPdf.class.php index c3e14a232a..29c823d816 100644 --- a/libraries/plugins/export/PMA_ExportPdf.class.php +++ b/libraries/plugins/export/PMA_ExportPdf.class.php @@ -160,6 +160,13 @@ class PMA_ExportPdf extends PMA_PDF $this->SetAutoPageBreak(true); } + /** + * Generate table + * + * @param int $lineheight Height of line + * + * @return void + */ function morepagestable($lineheight = 8) { // some things to set and 'remember' @@ -265,6 +272,13 @@ class PMA_ExportPdf extends PMA_PDF $this->tMargin = $topMargin; } + /** + * MySQL report + * + * @param string $query Query to execute + * + * @return void + */ function mysqlReport($query) { unset($this->tablewidths); diff --git a/libraries/plugins/export/TableProperty.class.php b/libraries/plugins/export/TableProperty.class.php index a928a6c3d1..cf7c6fcbe4 100644 --- a/libraries/plugins/export/TableProperty.class.php +++ b/libraries/plugins/export/TableProperty.class.php @@ -64,8 +64,6 @@ class TableProperty * Constructor * * @param array $row table row - * - * @return void */ function __construct($row) { diff --git a/libraries/plugins/import/ShapeFile.class.php b/libraries/plugins/import/ShapeFile.class.php index 121bf124d2..bad2751579 100644 --- a/libraries/plugins/import/ShapeFile.class.php +++ b/libraries/plugins/import/ShapeFile.class.php @@ -78,7 +78,7 @@ class PMA_ShapeFile extends ShapeFile /** * Loads geometry data from the ESRI shape file * - * @return void + * @return boolean|void * @see ShapeFile::_loadRecords() */ function _loadRecords() diff --git a/libraries/plugins/import/ShapeRecord.class.php b/libraries/plugins/import/ShapeRecord.class.php index efefd0c806..7317c00aa4 100644 --- a/libraries/plugins/import/ShapeRecord.class.php +++ b/libraries/plugins/import/ShapeRecord.class.php @@ -82,7 +82,7 @@ class PMA_ShapeRecord extends ShapeRecord /** * Loads data from a point record * - * @return void + * @return array * @see ShapeRecord::_loadPoint() */ function _loadPoint() diff --git a/libraries/plugins/transformations/abstract/AppendTransformationsPlugin.class.php b/libraries/plugins/transformations/abstract/AppendTransformationsPlugin.class.php index 8d80922e56..86bb0be74b 100644 --- a/libraries/plugins/transformations/abstract/AppendTransformationsPlugin.class.php +++ b/libraries/plugins/transformations/abstract/AppendTransformationsPlugin.class.php @@ -41,7 +41,7 @@ abstract class AppendTransformationsPlugin extends TransformationsPlugin * @param array $options transformation options * @param string $meta meta information * - * @return void + * @return string */ public function applyTransformation($buffer, $options = array(), $meta = '') { diff --git a/libraries/relation.lib.php b/libraries/relation.lib.php index 15d5f62d05..467def2847 100644 --- a/libraries/relation.lib.php +++ b/libraries/relation.lib.php @@ -344,7 +344,7 @@ function PMA_getDiagMessageForFeature($feature_name, * @param array $messages utility messages * @param string $doc_anchor anchor in documentation * - * @return void + * @return string */ function PMA_getDiagMessageForParameter($parameter, $relation_parameter_set, $messages, $doc_anchor @@ -1364,7 +1364,7 @@ function PMA_REL_renameField($db, $table, $field, $new_name) * @param string $db_field Name of database field * @param string $table_field Name of table field * - * @return nothing. + * @return void */ function PMA_REL_renameSingleTable($table, $source_db, $target_db, @@ -1395,7 +1395,7 @@ function PMA_REL_renameSingleTable($table, * @param string $source_table Source table name * @param string $target_table Target table name * - * @return nothing + * @return void */ function PMA_REL_renameTable($source_db, $target_db, $source_table, $target_table) { diff --git a/libraries/replication.inc.php b/libraries/replication.inc.php index 86829e12ba..0a35978e7e 100644 --- a/libraries/replication.inc.php +++ b/libraries/replication.inc.php @@ -215,7 +215,7 @@ function PMA_Replication_Slave_control($action, $control = null, $link = null) * @param bool $start shall we start slave? * @param mixed $link mysql link * - * @return output of CHANGE MASTER mysql command + * @return string output of CHANGE MASTER mysql command */ function PMA_Replication_Slave_changeMaster($user, $password, $host, $port, $pos, $stop = true, $start = true, $link = null diff --git a/libraries/replication_gui.lib.php b/libraries/replication_gui.lib.php index 6f4896ff01..eeac7fdf1f 100644 --- a/libraries/replication_gui.lib.php +++ b/libraries/replication_gui.lib.php @@ -472,7 +472,7 @@ function PMA_getHtmlForAddUserInputDiv($label_array, $input_array) * @param string $type either master or slave * @param boolean $hidden if true, then default style is set to hidden, * default value false - * @param boolen $title if true, then title is displayed, default true + * @param boolean $title if true, then title is displayed, default true * * @return String HTML code */ @@ -581,7 +581,7 @@ function PMA_getHtmlForReplicationStatusTable($type, $hidden = false, $title = t * @param boolean $hidden - if true, then default style is set to hidden, * - default value false * - * @return void + * @return string */ function PMA_getHtmlForReplicationSlavesTable($hidden = false) { diff --git a/libraries/rte/rte_routines.lib.php b/libraries/rte/rte_routines.lib.php index 52ffd5db28..0f8f75a815 100644 --- a/libraries/rte/rte_routines.lib.php +++ b/libraries/rte/rte_routines.lib.php @@ -12,7 +12,7 @@ if (! defined('PHPMYADMIN')) { /** * Sets required globals * - * @return nothing + * @return void */ function PMA_RTN_setGlobals() { @@ -37,7 +37,7 @@ function PMA_RTN_setGlobals() * 'PROCEDURE' for procedures, * null for both * - * @return nothing + * @return void */ function PMA_RTN_main($type) { @@ -266,7 +266,7 @@ function PMA_RTN_parseRoutineDefiner($parsed_query) /** * Handles editor requests for adding or editing an item * - * @return Does not return + * @return void */ function PMA_RTN_handleEditor() { @@ -1302,7 +1302,7 @@ function PMA_RTN_getQueryFromRequest() /** * Handles requests for executing a routine * - * @return Does not return + * @return void */ function PMA_RTN_handleExecute() { diff --git a/libraries/server_privileges.lib.php b/libraries/server_privileges.lib.php index fe67b87bae..ced06add1f 100644 --- a/libraries/server_privileges.lib.php +++ b/libraries/server_privileges.lib.php @@ -409,7 +409,7 @@ function PMA_getGrantsArray() * @param string $name_for_dfn name for dfn * @param string $name_for_current name for current * - * @return $html_output html snippet + * @return string $html_output html snippet */ function PMA_getHtmlForDisplayColumnPrivileges($columns, $row, $name_for_select, $priv_for_header, $name, $name_for_dfn, $name_for_current @@ -2160,7 +2160,7 @@ function PMA_getHtmlTableBodyForSpecificDbOrTablePrivs($privMap, $db, $table = n * @param string $dbname Database name * @param string $tablename Table name * - * @return HTML code with link + * @return string HTML code with link */ function PMA_getUserEditLink($username, $hostname, $dbname = '', $tablename = '') { @@ -2187,7 +2187,7 @@ function PMA_getUserEditLink($username, $hostname, $dbname = '', $tablename = '' * @param string $dbname Database name * @param string $tablename Table name * - * @return HTML code with link + * @return string HTML code with link */ function PMA_getUserRevokeLink($username, $hostname, $dbname = '', $tablename = '') { @@ -2234,9 +2234,9 @@ function PMA_getUserExportLink($username, $hostname, $initial = '') /** * Returns user group edit link - * + * * @param string $username User name - * + * * @return HTML code with link */ function PMA_getUserGroupEditLink($username) @@ -2308,7 +2308,7 @@ function PMA_getExtraDataForAjaxBehavior( $new_user_string .= '
' . join(', ', PMA_extractPrivInfo('', true)) . ''
. '