Remove some useless docblock comments

Fixes docblock spacing Signed-off-by: Maurício Meneghini Fauth <mauricio@fauth.dev>
phpmyadmin · Dec 14, 2019 · 39f42f8 · 39f42f8
1 parent 3567883
commit 39f42f8
Show file tree

Hide file tree

Showing 322 changed files with 1,128 additions and 868 deletions.
diff --git a/index.php b/index.php
@@ -22,6 +22,7 @@
 
 /**
  * See FAQ 1.34.
+ *
  * @see https://docs.phpmyadmin.net/en/latest/faq.html#faq1-34
  */
 if (($route === '/' || $route === '') && isset($_GET['db']) && mb_strlen($_GET['db']) !== 0) {

diff --git a/libraries/classes/Advisor.php b/libraries/classes/Advisor.php
@@ -362,6 +362,7 @@ public static function escapePercent(string $str): string
      * @param string $param the parameters
      *
      * @return string
+     *
      * @throws Exception
      */
     public function translate(string $str, ?string $param = null): string
@@ -401,6 +402,7 @@ public static function splitJustification(array $rule): array
      * @param array  $rule rule itself
      *
      * @return void
+     *
      * @throws Exception
      */
     public function addRule(string $type, array $rule): void

diff --git a/libraries/classes/Bookmark.php b/libraries/classes/Bookmark.php
@@ -59,8 +59,6 @@ class Bookmark
     private $user;
 
     /**
-     * Bookmark constructor.
-     *
      * @param DatabaseInterface $dbi  DatabaseInterface object
      * @param string            $user Current user
      */
@@ -213,6 +211,7 @@ public function applyVariables(array $variables): string
      * @param string $user Current user
      *
      * @return array|bool the bookmark parameters for the current user
+     *
      * @access  public
      */
     public static function getParams(string $user)
@@ -358,7 +357,6 @@ public static function getList(
      * @return Bookmark the bookmark
      *
      * @access  public
-     *
      */
     public static function get(
         DatabaseInterface $dbi,

diff --git a/libraries/classes/CentralColumns.php b/libraries/classes/CentralColumns.php
@@ -87,6 +87,7 @@ public function __construct(DatabaseInterface $dbi)
      * Defines the central_columns parameters for the current user
      *
      * @return array|bool the central_columns parameters for the current user
+     *
      * @access public
      */
     public function getParams()
@@ -686,6 +687,7 @@ public function updateOneColumn(
      * Update Multiple column in central columns list if a change is requested
      *
      * @param array $params Request parameters
+     *
      * @return true|Message
      */
     public function updateMultipleColumn(array $params)

diff --git a/libraries/classes/Charsets.php b/libraries/classes/Charsets.php
@@ -51,6 +51,7 @@ class Charsets
 
     /**
      * The charset for the server
+     *
      * @var Charset|null
      */
     private static $serverCharset = null;

diff --git a/libraries/classes/Charsets/Charset.php b/libraries/classes/Charsets/Charset.php
@@ -1,6 +1,7 @@
 <?php
 /**
  * Value object class for a character set
+ *
  * @package PhpMyAdmin\Charsets
  */
 declare(strict_types=1);
@@ -9,30 +10,35 @@
 
 /**
  * Value object class for a character set
+ *
  * @package PhpMyAdmin\Charsets
  */
 final class Charset
 {
     /**
      * The character set name
+     *
      * @var string
      */
     private $name;
 
     /**
      * A description of the character set
+     *
      * @var string
      */
     private $description;
 
     /**
      * The default collation for the character set
+     *
      * @var string
      */
     private $defaultCollation;
 
     /**
      * The maximum number of bytes required to store one character
+     *
      * @var int
      */
     private $maxLength;
@@ -57,6 +63,7 @@ private function __construct(
 
     /**
      * @param array $state State obtained from the database server
+     *
      * @return Charset
      */
     public static function fromServer(array $state): self

diff --git a/libraries/classes/Charsets/Collation.php b/libraries/classes/Charsets/Collation.php
@@ -1,6 +1,7 @@
 <?php
 /**
  * Value object class for a collation
+ *
  * @package PhpMyAdmin\Charsets
  */
 declare(strict_types=1);
@@ -9,54 +10,63 @@
 
 /**
  * Value object class for a collation
+ *
  * @package PhpMyAdmin\Charsets
  */
 final class Collation
 {
     /**
      * The collation name
+     *
      * @var string
      */
     private $name;
 
     /**
      * A description of the collation
+     *
      * @var string
      */
     private $description;
 
     /**
      * The name of the character set with which the collation is associated
+     *
      * @var string
      */
     private $charset;
 
     /**
      * The collation ID
+     *
      * @var int
      */
     private $id;
 
     /**
      * Whether the collation is the default for its character set
+     *
      * @var bool
      */
     private $isDefault;
 
     /**
      * Whether the character set is compiled into the server
+     *
      * @var bool
      */
     private $isCompiled;
 
     /**
      * Used for determining the memory used to sort strings in this collation
+     *
      * @var int
      */
     private $sortLength;
 
     /**
      * The collation pad attribute
+     *
      * @var string
      */
     private $padAttribute;
@@ -91,6 +101,7 @@ private function __construct(
 
     /**
      * @param array $state State obtained from the database server
+     *
      * @return self
      */
     public static function fromServer(array $state): self

diff --git a/libraries/classes/CheckUserPrivileges.php b/libraries/classes/CheckUserPrivileges.php
@@ -162,14 +162,14 @@ public function checkRequiredPrivilegesForAdjust(
      * (no control user needed) and we don't have to try any other method for
      * detection
      *
+     * @return void
+     *
      * @todo fix to get really all privileges, not only explicitly defined for this user
      * from MySQL manual: (https://dev.mysql.com/doc/refman/5.0/en/show-grants.html)
      * SHOW GRANTS displays only the privileges granted explicitly to the named
      * account. Other privileges might be available to the account, but they are not
      * displayed. For example, if an anonymous account exists, the named account
      * might be able to use its privileges, but SHOW GRANTS will not display them.
-     *
-     * @return void
      */
     private function analyseShowGrant(): void
     {

diff --git a/libraries/classes/Config.php b/libraries/classes/Config.php
@@ -355,7 +355,9 @@ public function checkWebServerOs(): void
 
     /**
      * detects if Git revision
+     *
      * @param string $git_location (optional) verified git directory
+     *
      * @return boolean
      */
     public function isGitRevision(&$git_location = null): bool
@@ -1526,6 +1528,7 @@ public function getCookie(string $cookieName)
      * Get the real cookie name
      *
      * @param string $cookieName The name of the cookie
+     *
      * @return string
      */
     public function getCookieName(string $cookieName): string

diff --git a/libraries/classes/Config/ConfigFile.php b/libraries/classes/Config/ConfigFile.php
@@ -20,56 +20,65 @@ class ConfigFile
 {
     /**
      * Stores default PMA config from config.default.php
+     *
      * @var array
      */
     private $_defaultCfg;
 
     /**
      * Stores allowed values for non-standard fields
+     *
      * @var array
      */
     private $_cfgDb;
 
     /**
      * Stores original PMA config, not modified by user preferences
+     *
      * @var array|null
      */
     private $_baseCfg;
 
     /**
      * Whether we are currently working in PMA Setup context
+     *
      * @var bool
      */
     private $_isInSetup;
 
     /**
      * Keys which will be always written to config file
+     *
      * @var array
      */
     private $_persistKeys = [];
 
     /**
      * Changes keys while updating config in {@link updateWithGlobalConfig()}
      * or reading by {@link getConfig()} or {@link getConfigArray()}
+     *
      * @var array
      */
     private $_cfgUpdateReadMapping = [];
 
     /**
      * Key filter for {@link set()}
+     *
      * @var array|null
      */
     private $_setFilter;
 
     /**
      * Instance id (key in $_SESSION array, separate for each server -
      * ConfigFile{server id})
+     *
      * @var string
      */
     private $_id;
 
     /**
      * Result for {@link _flattenArray()}
+     *
      * @var array|null
      */
     private $_flattenArrayResult;

diff --git a/libraries/classes/Config/Form.php b/libraries/classes/Config/Form.php
@@ -20,36 +20,42 @@ class Form
 {
     /**
      * Form name
+     *
      * @var string
      */
     public $name;
 
     /**
      * Arbitrary index, doesn't affect class' behavior
+     *
      * @var int
      */
     public $index;
 
     /**
      * Form fields (paths), filled by {@link readFormPaths()}, indexed by field name
+     *
      * @var array
      */
     public $fields;
 
     /**
      * Stores default values for some fields (eg. pmadb tables)
+     *
      * @var array
      */
     public $default;
 
     /**
      * Caches field types, indexed by field names
+     *
      * @var array
      */
     private $_fieldsTypes;
 
     /**
      * ConfigFile instance
+     *
      * @var ConfigFile
      */
     private $_configFile;