Use [] in doc-comments

diff --git a/adminer/drivers/mysql.inc.php b/adminer/drivers/mysql.inc.php
index 61b1699ab73929b374c8a040341e8d39ff9e6616..9feaa054e0290077a3d415f74421b65665c8bd76 100644 (file)
--- a/adminer/drivers/mysql.inc.php
+++ b/adminer/drivers/mysql.inc.php
@@ -476,7 +476,7 @@ if (!defined("DRIVER")) {
        }
 
        /** Get tables list
-       * @return array array($name => $type)
+       * @return array [$name => $type]
        */
        function tables_list() {
                return get_key_vals(min_version(5)
@@ -487,7 +487,7 @@ if (!defined("DRIVER")) {
 
        /** Count tables in all databases
        * @param array
-       * @return array array($db => $tables)
+       * @return array arra($db => $tables)
        */
        function count_tables($databases) {
                $return = array();
@@ -500,7 +500,7 @@ if (!defined("DRIVER")) {
        /** Get table status
        * @param string
        * @param bool return only "Name", "Engine" and "Comment" fields
-       * @return array array($name => array("Name" => , "Engine" => , "Comment" => , "Oid" => , "Rows" => , "Collation" => , "Auto_increment" => , "Data_length" => , "Index_length" => , "Data_free" => )) or only inner array with $name
+       * @return array [$name => array("Name" => , "Engine" => , "Comment" => , "Oid" => , "Rows" => , "Collation" => , "Auto_increment" => , "Data_length" => , "Index_length" => , "Data_free" => )] or only inner array with $name
        */
        function table_status($name = "", $fast = false) {
                $return = array();
@@ -544,7 +544,7 @@ if (!defined("DRIVER")) {
 
        /** Get information about fields
        * @param string
-       * @return array array($name => array("field" => , "full_type" => , "type" => , "length" => , "unsigned" => , "default" => , "null" => , "auto_increment" => , "on_update" => , "collation" => , "privileges" => , "comment" => , "primary" => ))
+       * @return array [$name => array("field" => , "full_type" => , "type" => , "length" => , "unsigned" => , "default" => , "null" => , "auto_increment" => , "on_update" => , "collation" => , "privileges" => , "comment" => , "primary" => )]
        */
        function fields($table) {
                $return = array();
@@ -574,7 +574,7 @@ if (!defined("DRIVER")) {
        /** Get table indexes
        * @param string
        * @param string Min_DB to use
-       * @return array array($key_name => array("type" => , "columns" => array(), "lengths" => array(), "descs" => array()))
+       * @return array [$key_name => array("type" => , "columns" => array(), "lengths" => array(), "descs" => array())]
        */
        function indexes($table, $connection2 = null) {
                $return = array();
@@ -590,7 +590,7 @@ if (!defined("DRIVER")) {
 
        /** Get foreign keys in table
        * @param string
-       * @return array array($name => array("db" => , "ns" => , "table" => , "source" => array(), "target" => array(), "on_delete" => , "on_update" => ))
+       * @return array [$name => array("db" => , "ns" => , "table" => , "source" => array(), "target" => array(), "on_delete" => , "on_update" => )]
        */
        function foreign_keys($table) {
                global $connection, $on_actions;
@@ -617,7 +617,7 @@ if (!defined("DRIVER")) {
 
        /** Get view SELECT
        * @param string
-       * @return array array("select" => )
+       * @return array ["select" => ]
        */
        function view($name) {
                global $connection;
@@ -866,7 +866,7 @@ if (!defined("DRIVER")) {
 
        /** Get information about trigger
        * @param string trigger name
-       * @return array array("Trigger" => , "Timing" => , "Event" => , "Of" => , "Type" => , "Statement" => )
+       * @return array ["Trigger" => , "Timing" => , "Event" => , "Of" => , "Type" => , "Statement" => ]
        */
        function trigger($name) {
                if ($name == "") {
@@ -878,7 +878,7 @@ if (!defined("DRIVER")) {
 
        /** Get defined triggers
        * @param string
-       * @return array array($name => array($timing, $event))
+       * @return array [$name => array($timing, $event)]
        */
        function triggers($table) {
                $return = array();
@@ -889,7 +889,7 @@ if (!defined("DRIVER")) {
        }
 
        /** Get trigger options
-       * @return array ("Timing" => array(), "Event" => array(), "Type" => array())
+       * @return array ["Timing" => array(), "Event" => array(), "Type" => array()]
        */
        function trigger_options() {
                return array(
@@ -902,7 +902,7 @@ if (!defined("DRIVER")) {
        /** Get information about stored routine
        * @param string
        * @param string "FUNCTION" or "PROCEDURE"
-       * @return array ("fields" => array("field" => , "type" => , "length" => , "unsigned" => , "inout" => , "collation" => ), "returns" => , "definition" => , "language" => )
+       * @return array ["fields" => array("field" => , "type" => , "length" => , "unsigned" => , "inout" => , "collation" => ), "returns" => , "definition" => , "language" => ]
        */
        function routine($name, $type) {
                global $connection, $enum_length, $inout, $types;
@@ -938,7 +938,7 @@ if (!defined("DRIVER")) {
        }
 
        /** Get list of routines
-       * @return array ("SPECIFIC_NAME" => , "ROUTINE_NAME" => , "ROUTINE_TYPE" => , "DTD_IDENTIFIER" => )
+       * @return array ["SPECIFIC_NAME" => , "ROUTINE_NAME" => , "ROUTINE_TYPE" => , "DTD_IDENTIFIER" => ]
        */
        function routines() {
                return get_rows("SELECT ROUTINE_NAME AS SPECIFIC_NAME, ROUTINE_NAME, ROUTINE_TYPE, DTD_IDENTIFIER FROM information_schema.ROUTINES WHERE ROUTINE_SCHEMA = " . q(DB));
@@ -1060,7 +1060,7 @@ if (!defined("DRIVER")) {
        }
 
        /** Get server variables
-       * @return array ($name => $value)
+       * @return array [$name => $value]
        */
        function show_variables() {
                return get_key_vals("SHOW VARIABLES");
@@ -1080,14 +1080,14 @@ if (!defined("DRIVER")) {
        }
 
        /** Get process list
-       * @return array ($row)
+       * @return array [$row]
        */
        function process_list() {
                return get_rows("SHOW FULL PROCESSLIST");
        }
 
        /** Get status variables
-       * @return array ($name => $value)
+       * @return array [$name => $value]
        */
        function show_status() {
                return get_key_vals("SHOW STATUS");
@@ -1160,11 +1160,11 @@ if (!defined("DRIVER")) {
        }
 
        /** Get driver config
-       * @return array array('possible_drivers' => , 'jush' => , 'types' => , 'structured_types' => , 'unsigned' => , 'operators' => , 'functions' => , 'grouping' => , 'edit_functions' => )
+       * @return array ['possible_drivers' => , 'jush' => , 'types' => , 'structured_types' => , 'unsigned' => , 'operators' => , 'functions' => , 'grouping' => , 'edit_functions' => ]
        */
        function driver_config() {
-               $types = array(); ///< @var array ($type => $maximum_unsigned_length, ...)
-               $structured_types = array(); ///< @var array ($description => array($type, ...), ...)
+               $types = array(); ///< @var array [$type => $maximum_unsigned_length, ...]
+               $structured_types = array(); ///< @var array [$description => array($type, ...), ...]
                foreach (array(
                        lang('Numbers') => array("tinyint" => 3, "smallint" => 5, "mediumint" => 8, "int" => 10, "bigint" => 20, "decimal" => 66, "float" => 12, "double" => 21),
                        lang('Date and time') => array("date" => 10, "datetime" => 19, "timestamp" => 19, "time" => 10, "year" => 4),

diff --git a/adminer/include/adminer.inc.php b/adminer/include/adminer.inc.php
index 33ddef293bb73ee64a5b4932e5bac84a34f91cde..593c49feb3659064dbd5d8c44b24fb6ffe7fd418 100644 (file)
--- a/adminer/include/adminer.inc.php
+++ b/adminer/include/adminer.inc.php
@@ -13,14 +13,14 @@ class Adminer {
        }
 
        /** Connection parameters
-       * @return array ($server, $username, $password)
+       * @return array [$server, $username, $password]
        */
        function credentials() {
                return array(SERVER, $_GET["username"], get_password());
        }
 
        /** Get SSL connection options
-       * @return array array("key" => filename, "cert" => filename, "ca" => filename) or null
+       * @return array ["key" => filename, "cert" => filename, "ca" => filename] or null
        */
        function connectSsl() {
        }
@@ -510,7 +510,7 @@ class Adminer {
        /** Process columns box in select
        * @param array selectable columns
        * @param array
-       * @return array (array(select_expressions), array(group_expressions))
+       * @return array [array(select_expressions), array(group_expressions)]
        */
        function selectColumnsProcess($columns, $indexes) {
                global $functions, $grouping;

diff --git a/adminer/include/driver.inc.php b/adminer/include/driver.inc.php
index 4abbe59bf716bb97825c3c058fb2f51cbe6cb90c..cf577768b1cc5a6a3de045aaea8ca14343be627e 100644 (file)
--- a/adminer/include/driver.inc.php
+++ b/adminer/include/driver.inc.php
@@ -143,7 +143,7 @@ function get_driver($id) {
 
        /** Convert column to be searchable
        * @param string escaped column name
-       * @param array array("op" => , "val" => )
+       * @param array ["op" => , "val" => ]
        * @param array
        * @return string
        */

diff --git a/adminer/include/editing.inc.php b/adminer/include/editing.inc.php
index 478ece4ed9c3016495f19da410a67956b4ed9ef0..c53539fafbe2abd33a152270acd2a60e883c2efb 100644 (file)
--- a/adminer/include/editing.inc.php
+++ b/adminer/include/editing.inc.php
@@ -98,7 +98,7 @@ function select($result, $connection2 = null, $orgtables = array(), $limit = 0)
 
 /** Get referencable tables with single column primary key except self
 * @param string
-* @return array ($table_name => $field)
+* @return array [$table_name => $field]
 */
 function referencable_primary($self) {
        $return = array(); // table_name => field
@@ -277,7 +277,7 @@ function process_type($field, $collate = "COLLATE") {
 /** Create SQL string from field
 * @param array basic field information
 * @param array information about field type
-* @return array array("field", "type", "NULL", "DEFAULT", "ON UPDATE", "COMMENT", "AUTO_INCREMENT")
+* @return array ["field", "type", "NULL", "DEFAULT", "ON UPDATE", "COMMENT", "AUTO_INCREMENT"]
 */
 function process_field($field, $type_field) {
        // MariaDB exports CURRENT_TIMESTAMP as a function.
@@ -533,7 +533,7 @@ function create_routine($routine, $row) {
 
 /** Get defined check constraints
 * @param string
-* @return array array($name => $clause)
+* @return array [$name => $clause]
 */
 function check_constraints($table) {
        // MariaDB contains CHECK_CONSTRAINTS.TABLE_NAME, MySQL and PostrgreSQL not
@@ -554,7 +554,7 @@ function remove_definer($query) {
 }
 
 /** Format foreign key to use in SQL query
-* @param array ("db" => string, "ns" => string, "table" => string, "source" => array, "target" => array, "on_delete" => one of $on_actions, "on_update" => one of $on_actions)
+* @param array ["db" => string, "ns" => string, "table" => string, "source" => array, "target" => array, "on_delete" => one of $on_actions, "on_update" => one of $on_actions]
 * @return string
 */
 function format_foreign_key($foreign_key) {

diff --git a/adminer/include/functions.inc.php b/adminer/include/functions.inc.php
index 5fae055378f7b4e4e9bcf3b4191906ef56576c69..397b7266f4b9485491ddb757b64e895396c6a4dc 100644 (file)
--- a/adminer/include/functions.inc.php
+++ b/adminer/include/functions.inc.php
@@ -851,7 +851,7 @@ function table_status1($table, $fast = false) {
 
 /** Find out foreign keys for each column
 * @param string
-* @return array array($col => array())
+* @return array [$col => array()]
 */
 function column_foreign_keys($table) {
        global $adminer;

diff --git a/plugins/login-servers.php b/plugins/login-servers.php
index 50203f5adaeaa798f648708172098b0b65ada9ab..cac6b28f6f28fb74c1d9be0e3619071f85f2edc0 100644 (file)
--- a/plugins/login-servers.php
+++ b/plugins/login-servers.php
@@ -11,7 +11,7 @@ class AdminerLoginServers {
        var $servers;
 
        /** Set supported servers
-       * @param array array($description => array("server" => , "driver" => "server|pgsql|sqlite|..."))
+       * @param array [$description => array("server" => , "driver" => "server|pgsql|sqlite|...")]
        */
        function __construct($servers) {
                $this->servers = $servers;

diff --git a/plugins/master-slave.php b/plugins/master-slave.php
index eb42e6aec91835cfe3a2c1d4d36aa5678635ca41..e76bb047eb0840688ba1a2e37b6a62308f34a4f8 100644 (file)
--- a/plugins/master-slave.php
+++ b/plugins/master-slave.php
@@ -10,7 +10,7 @@ class AdminerMasterSlave {
        private $masters = array();
 
        /**
-       * @param array ($slave => $master)
+       * @param array [$slave => $master]
        */
        function __construct($masters) {
                $this->masters = $masters;