Skip to content

Commit

Permalink
Update PHPDoc.
Browse files Browse the repository at this point in the history
Signed-off-by: Hugues Peccatte <[email protected]>
  • Loading branch information
Tithugues committed Dec 11, 2015
1 parent f04a678 commit 8baf7c4
Show file tree
Hide file tree
Showing 14 changed files with 33 additions and 33 deletions.
2 changes: 1 addition & 1 deletion libraries/Util.php
Original file line number Diff line number Diff line change
Expand Up @@ -4288,7 +4288,7 @@ public static function parseEnumSetValues($definition, $escapeHtml = true)
/**
* Get regular expression which occur first inside the given sql query.
*
* @param Array $regex_array Comparing regular expressions.
* @param array $regex_array Comparing regular expressions.
* @param String $query SQL query to be checked.
*
* @return String Matching regular expression.
Expand Down
4 changes: 2 additions & 2 deletions libraries/controllers/server/ServerVariablesController.php
Original file line number Diff line number Diff line change
Expand Up @@ -292,8 +292,8 @@ private function _getHtmlForServerVariables($serverVars, $serverVarsSession)
/**
* Prints Html for Server Variables Items
*
* @param Array $serverVars global variables
* @param Array $serverVarsSession session variables
* @param array $serverVars global variables
* @param array $serverVarsSession session variables
*
* @return string
*/
Expand Down
14 changes: 7 additions & 7 deletions libraries/error_report.lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ function PMA_getPrettyReportData()
*
* @param string $exception_type whether exception is 'js' or 'php'
*
* @return Array error report if success, Empty Array otherwise
* @return array error report if success, Empty Array otherwise
*/
function PMA_getReportData($exception_type = 'js')
{
Expand Down Expand Up @@ -131,7 +131,7 @@ function PMA_getReportData($exception_type = 'js')
*
* @param String $url the url to sanitize
*
* @return Array the uri and script name
* @return array the uri and script name
*/
function PMA_sanitizeUrl($url)
{
Expand Down Expand Up @@ -171,7 +171,7 @@ function PMA_sanitizeUrl($url)
/**
* Sends report data to the error reporting server
*
* @param Array $report the report info to be sent
* @param array $report the report info to be sent
*
* @return String the reply of the server
*/
Expand Down Expand Up @@ -262,11 +262,11 @@ function PMA_countLines($filename)
*
* uses the $LINE_COUNT global array of file names and line numbers
*
* @param Array $filenames list of files in order of concatenation
* @param array $filenames list of files in order of concatenation
* @param Integer $cumulative_number the cumulative line number in the
* concatenated files
*
* @return Array the filename and line number
* @return array the filename and line number
* Returns two variables in an array:
* - A String $filename the filename where the requested cumulative number
* exists
Expand All @@ -293,9 +293,9 @@ function PMA_getLineNumber($filenames, $cumulative_number)
* translates the cumulative line numbers in the stack trace as well as sanitize
* urls and trim long lines in the context
*
* @param Array $stack the stack trace
* @param array $stack the stack trace
*
* @return Array $stack the modified stack trace
* @return array $stack the modified stack trace
*/
function PMA_translateStacktrace($stack)
{
Expand Down
2 changes: 1 addition & 1 deletion libraries/navigation/nodes/Node.php
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ class Node
*/
public $icon;
/**
* @var Array An array of A tags, used when rendering the node
* @var array An array of A tags, used when rendering the node
* The indexes in the array may be 'icon' and 'text'
*/
public $links;
Expand Down
2 changes: 1 addition & 1 deletion libraries/plugins/export/ExportSql.php
Original file line number Diff line number Diff line change
Expand Up @@ -2639,7 +2639,7 @@ public function replaceWithAliases(
/**
* The statement that represents the query.
*
* @var CreateStatement $statement
* @var \SqlParser\Statements\CreateStatement $statement
*/
$statement = $parser->statements[0];

Expand Down
2 changes: 1 addition & 1 deletion libraries/properties/options/OptionsPropertyOneItem.php
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ public function setValues($values)
/**
* Gets MySQL documentation pointer
*
* @return arrray
* @return array
*/
public function getDoc()
{
Expand Down
6 changes: 3 additions & 3 deletions libraries/replication_gui.lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ function PMA_getHtmlForMasterConfiguration()
* returns HTML for slave replication configuration
*
* @param bool $server_slave_status Whether it is Master or Slave
* @param Array $server_slave_replication Slave replication
* @param array $server_slave_replication Slave replication
*
* @return String HTML code
*/
Expand Down Expand Up @@ -468,8 +468,8 @@ function PMA_getHtmlForReplicationChangeMaster($submitname)
/**
* returns HTML code for Add user input div
*
* @param Array $label_array label tag elements
* @param Array $input_array input tag elements
* @param array $label_array label tag elements
* @param array $input_array input tag elements
*
* @return String HTML code
*/
Expand Down
8 changes: 4 additions & 4 deletions libraries/server_bin_log.lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
/**
* Returns the html for log selector.
*
* @param Array $binary_logs Binary logs file names
* @param Array $url_params links parameters
* @param array $binary_logs Binary logs file names
* @param array $url_params links parameters
*
* @return string
*/
Expand Down Expand Up @@ -67,7 +67,7 @@ function PMA_getLogSelector($binary_logs, $url_params)
/**
* Returns the html for binary log information.
*
* @param Array $url_params links parameters
* @param array $url_params links parameters
*
* @return string
*/
Expand Down Expand Up @@ -144,7 +144,7 @@ function PMA_getLogInfo($url_params)
/**
* Returns the html for Navigation Row.
*
* @param Array $url_params Links parameters
* @param array $url_params Links parameters
* @param int $pos Position to display
* @param int $num_rows Number of results row
* @param bool $dontlimitchars Whether limit chars
Expand Down
4 changes: 2 additions & 2 deletions libraries/server_plugins.lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ function PMA_getServerPlugins()
/**
* Returns the html for plugin Tab.
*
* @param Array $plugins list
* @param array $plugins list
*
* @return string
*/
Expand Down Expand Up @@ -93,7 +93,7 @@ function PMA_getPluginTab($plugins)
/**
* Returns the html for plugin List.
*
* @param Array $plugin_list list
* @param array $plugin_list list
*
* @return string
*/
Expand Down
2 changes: 1 addition & 1 deletion libraries/server_privileges.lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -3901,7 +3901,7 @@ function PMA_deleteUser($queries)
* @param string $hostname host name
* @param string $tablename table name
* @param string $dbname database name
* @param strubg $itemType item type
* @param string $itemType item type
*
* @return Message success message or error message for update
*/
Expand Down
10 changes: 5 additions & 5 deletions libraries/server_status_monitor.lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ function PMA_getHtmlForClientSideDataAndLinks($ServerStatusData)
/**
* Returns JSon for real-time charting data
*
* @return Array
* @return array
*/
function PMA_getJsonForChartingData()
{
Expand Down Expand Up @@ -553,7 +553,7 @@ function PMA_getJsonForChartingDataSwitch(
* @param int $start Unix Time: Start time for query
* @param int $end Unix Time: End time for query
*
* @return Array
* @return array
*/
function PMA_getJsonForLogDataTypeSlow($start, $end)
{
Expand Down Expand Up @@ -619,7 +619,7 @@ function PMA_getJsonForLogDataTypeSlow($start, $end)
* @param int $start Unix Time: Start time for query
* @param int $end Unix Time: End time for query
*
* @return Array
* @return array
*/
function PMA_getJsonForLogDataTypeGeneral($start, $end)
{
Expand Down Expand Up @@ -739,7 +739,7 @@ function PMA_getSuspensionPoints($lastChar)
/**
* Returns JSon for logging vars
*
* @return Array
* @return array
*/
function PMA_getJsonForLoggingVars()
{
Expand Down Expand Up @@ -769,7 +769,7 @@ function PMA_getJsonForLoggingVars()
/**
* Returns JSon for query_analyzer
*
* @return Array
* @return array
*/
function PMA_getJsonForQueryAnalyzer()
{
Expand Down
2 changes: 1 addition & 1 deletion libraries/server_status_processes.lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ function PMA_getHtmlForProcessListFilter()
/**
* Prints Every Item of Server Process
*
* @param Array $process data of Every Item of Server Process
* @param array $process data of Every Item of Server Process
* @param bool $odd_row display odd row or not
* @param bool $show_full_sql show full sql or not
*
Expand Down
4 changes: 2 additions & 2 deletions libraries/server_status_variables.lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -200,8 +200,8 @@ function PMA_getHtmlForVariablesList($ServerStatusData)
* Returns HTML for render variables list
*
* @param ServerStatusData $ServerStatusData Server status data
* @param Array $alerts Alert Array
* @param Array $strShowStatus Status Array
* @param array $alerts Alert Array
* @param array $strShowStatus Status Array
*
* @return string
*/
Expand Down
4 changes: 2 additions & 2 deletions libraries/transformations.lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ function PMA_getTransformationClassName($filename)
*/
function PMA_getTransformationDescription($file)
{
/* @var $class_name TransformationsInterface */
/* @var $class_name PMA\libraries\plugins\TransformationsInterface */
$class_name = PMA_getTransformationClassName($file);
// include and instantiate the class
include_once $file;
Expand All @@ -184,7 +184,7 @@ function PMA_getTransformationDescription($file)
*/
function PMA_getTransformationName($file)
{
/* @var $class_name TransformationsInterface */
/* @var $class_name PMA\libraries\plugins\TransformationsInterface */
$class_name = PMA_getTransformationClassName($file);
// include and instantiate the class
include_once $file;
Expand Down

0 comments on commit 8baf7c4

Please sign in to comment.