Use one line for comments with a single line

Signed-off-by: Maurício Meneghini Fauth <mauricio@fauth.dev>
phpmyadmin · Jan 20, 2020 · 6283caa · 6283caa
1 parent c231652
commit 6283caa
Show file tree

Hide file tree

Showing 198 changed files with 396 additions and 1,188 deletions.
diff --git a/libraries/classes/Bookmark.php b/libraries/classes/Bookmark.php
@@ -46,9 +46,7 @@ class Bookmark
      */
     private $_query;
 
-    /**
-     * @var DatabaseInterface
-     */
+    /** @var DatabaseInterface */
     private $dbi;
 
     /**

diff --git a/libraries/classes/BrowseForeigners.php b/libraries/classes/BrowseForeigners.php
@@ -26,9 +26,7 @@ class BrowseForeigners
     /** @var string */
     private $themeImage;
 
-    /**
-     * @var Template
-     */
+    /** @var Template */
     public $template;
 
     /**

diff --git a/libraries/classes/CentralColumns.php b/libraries/classes/CentralColumns.php
@@ -55,14 +55,10 @@ class CentralColumns
      */
     private $disableIs;
 
-    /**
-     * @var Relation
-     */
+    /** @var Relation */
     private $relation;
 
-    /**
-     * @var Template
-     */
+    /** @var Template */
     public $template;
 
     /**

diff --git a/libraries/classes/Charsets.php b/libraries/classes/Charsets.php
@@ -56,14 +56,10 @@ class Charsets
      */
     private static $serverCharset = null;
 
-    /**
-     * @var array<string, Charset>
-     */
+    /** @var array<string, Charset> */
     private static $charsets = [];
 
-    /**
-     * @var array<string, array<string, Collation>>
-     */
+    /** @var array<string, array<string, Collation>> */
     private static $collations = [];
 
     /**

diff --git a/libraries/classes/CheckUserPrivileges.php b/libraries/classes/CheckUserPrivileges.php
@@ -18,9 +18,7 @@
  */
 class CheckUserPrivileges
 {
-    /**
-     * @var DatabaseInterface
-     */
+    /** @var DatabaseInterface */
     private $dbi;
 
     /**

diff --git a/libraries/classes/Config.php b/libraries/classes/Config.php
@@ -24,51 +24,33 @@
  */
 class Config
 {
-    /**
-     * @var string  default config source
-     */
+    /** @var string  default config source */
     public $default_source = ROOT_PATH . 'libraries/config.default.php';
 
-    /**
-     * @var array   default configuration settings
-     */
+    /** @var array   default configuration settings */
     public $default = [];
 
-    /**
-     * @var array   configuration settings, without user preferences applied
-     */
+    /** @var array   configuration settings, without user preferences applied */
     public $base_settings = [];
 
-    /**
-     * @var array   configuration settings
-     */
+    /** @var array   configuration settings */
     public $settings = [];
 
-    /**
-     * @var string  config source
-     */
+    /** @var string  config source */
     public $source = '';
 
-    /**
-     * @var int     source modification time
-     */
+    /** @var int     source modification time */
     public $source_mtime = 0;
     public $default_source_mtime = 0;
     public $set_mtime = 0;
 
-    /**
-     * @var boolean
-     */
+    /** @var boolean */
     public $error_config_file = false;
 
-    /**
-     * @var boolean
-     */
+    /** @var boolean */
     public $error_config_default_file = false;
 
-    /**
-     * @var array
-     */
+    /** @var array */
     public $default_server = [];
 
     /**

diff --git a/libraries/classes/Config/FormDisplay.php b/libraries/classes/Config/FormDisplay.php
@@ -94,9 +94,7 @@ class FormDisplay
      */
     private $_userprefsDisallow;
 
-    /**
-     * @var FormDisplayTemplate
-     */
+    /** @var FormDisplayTemplate */
     private $formDisplayTemplate;
 
     /**

diff --git a/libraries/classes/Config/FormDisplayTemplate.php b/libraries/classes/Config/FormDisplayTemplate.php
@@ -20,19 +20,13 @@
  */
 class FormDisplayTemplate
 {
-    /**
-     * @var int
-     */
+    /** @var int */
     public $group;
 
-    /**
-     * @var Config
-     */
+    /** @var Config */
     protected $config;
 
-    /**
-     * @var Template
-     */
+    /** @var Template */
     public $template;
 
     /**

diff --git a/libraries/classes/Config/Forms/BaseFormList.php b/libraries/classes/Config/Forms/BaseFormList.php
@@ -20,14 +20,10 @@ class BaseFormList
      */
     protected static $all = [];
 
-    /**
-     * @var string
-     */
+    /** @var string */
     protected static $ns = 'PhpMyAdmin\\Config\\Forms\\';
 
-    /**
-     * @var array
-     */
+    /** @var array */
     private $_forms;
 
     /**

diff --git a/libraries/classes/Config/Forms/Page/PageFormList.php b/libraries/classes/Config/Forms/Page/PageFormList.php
@@ -15,9 +15,7 @@
  */
 class PageFormList extends BaseFormList
 {
-    /**
-     * @var array
-     */
+    /** @var array */
     protected static $all = [
         'Browse',
         'DbStructure',
@@ -28,8 +26,6 @@ class PageFormList extends BaseFormList
         'Sql',
         'TableStructure',
     ];
-    /**
-     * @var string
-     */
+    /** @var string */
     protected static $ns = '\\PhpMyAdmin\\Config\\Forms\\Page\\';
 }
diff --git a/libraries/classes/Config/Forms/Setup/SetupFormList.php b/libraries/classes/Config/Forms/Setup/SetupFormList.php
@@ -15,9 +15,7 @@
  */
 class SetupFormList extends BaseFormList
 {
-    /**
-     * @var array
-     */
+    /** @var array */
     protected static $all = [
         'Config',
         'Export',
@@ -28,8 +26,6 @@ class SetupFormList extends BaseFormList
         'Servers',
         'Sql',
     ];
-    /**
-     * @var string
-     */
+    /** @var string */
     protected static $ns = '\\PhpMyAdmin\\Config\\Forms\\Setup\\';
 }
diff --git a/libraries/classes/Config/Forms/User/UserFormList.php b/libraries/classes/Config/Forms/User/UserFormList.php
@@ -15,9 +15,7 @@
  */
 class UserFormList extends BaseFormList
 {
-    /**
-     * @var array
-     */
+    /** @var array */
     protected static $all = [
         'Features',
         'Sql',
@@ -26,8 +24,6 @@ class UserFormList extends BaseFormList
         'Export',
         'Import',
     ];
-    /**
-     * @var string
-     */
+    /** @var string */
     protected static $ns = '\\PhpMyAdmin\\Config\\Forms\\User\\';
 }
diff --git a/libraries/classes/Config/PageSettings.php b/libraries/classes/Config/PageSettings.php
@@ -51,9 +51,7 @@ class PageSettings
      */
     private $_HTML = '';
 
-    /**
-     * @var UserPreferences
-     */
+    /** @var UserPreferences */
     private $userPreferences;
 
     /**

diff --git a/libraries/classes/Config/ServerConfigChecks.php b/libraries/classes/Config/ServerConfigChecks.php
@@ -26,9 +26,7 @@
  */
 class ServerConfigChecks
 {
-    /**
-     * @var ConfigFile configurations being checked
-     */
+    /** @var ConfigFile configurations being checked */
     protected $cfg;
 
     /**

diff --git a/libraries/classes/Console.php b/libraries/classes/Console.php
@@ -35,14 +35,10 @@ class Console
      */
     private $_isAjax;
 
-    /**
-     * @var Relation
-     */
+    /** @var Relation */
     private $relation;
 
-    /**
-     * @var Template
-     */
+    /** @var Template */
     public $template;
 
     /**

diff --git a/libraries/classes/Controllers/AbstractController.php b/libraries/classes/Controllers/AbstractController.php
@@ -19,19 +19,13 @@
  */
 abstract class AbstractController
 {
-    /**
-     * @var Response
-     */
+    /** @var Response */
     protected $response;
 
-    /**
-     * @var DatabaseInterface
-     */
+    /** @var DatabaseInterface */
     protected $dbi;
 
-    /**
-     * @var Template
-     */
+    /** @var Template */
     protected $template;
 
     /**

diff --git a/libraries/classes/Controllers/AjaxController.php b/libraries/classes/Controllers/AjaxController.php
@@ -21,9 +21,7 @@
  */
 class AjaxController extends AbstractController
 {
-    /**
-     * @var Config
-     */
+    /** @var Config */
     private $config;
 
     /**

diff --git a/libraries/classes/Controllers/BrowseForeignersController.php b/libraries/classes/Controllers/BrowseForeignersController.php
@@ -21,14 +21,10 @@
  */
 class BrowseForeignersController extends AbstractController
 {
-    /**
-     * @var BrowseForeigners
-     */
+    /** @var BrowseForeigners */
     private $browseForeigners;
 
-    /**
-     * @var Relation
-     */
+    /** @var Relation */
     private $relation;
 
     /**

diff --git a/libraries/classes/Controllers/Database/AbstractController.php b/libraries/classes/Controllers/Database/AbstractController.php
@@ -20,9 +20,7 @@
  */
 abstract class AbstractController extends Controller
 {
-    /**
-     * @var string
-     */
+    /** @var string */
     protected $db;
 
     /**

diff --git a/libraries/classes/Controllers/Database/CentralColumnsController.php b/libraries/classes/Controllers/Database/CentralColumnsController.php
@@ -20,9 +20,7 @@
  */
 class CentralColumnsController extends AbstractController
 {
-    /**
-     * @var CentralColumns
-     */
+    /** @var CentralColumns */
     private $centralColumns;
 
     /**

diff --git a/libraries/classes/Controllers/Database/DataDictionaryController.php b/libraries/classes/Controllers/Database/DataDictionaryController.php
@@ -21,14 +21,10 @@
  */
 class DataDictionaryController extends AbstractController
 {
-    /**
-     * @var Relation
-     */
+    /** @var Relation */
     private $relation;
 
-    /**
-     * @var Transformations
-     */
+    /** @var Transformations */
     private $transformations;
 
     /**