Remove useless comments in PHP docs

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

Hide file tree

Showing 98 changed files with 2 additions and 242 deletions.
diff --git a/libraries/classes/Advisor.php b/libraries/classes/Advisor.php
@@ -37,8 +37,6 @@ class Advisor
     protected $expression;
 
     /**
-     * Constructor
-     *
      * @param DatabaseInterface  $dbi        DatabaseInterface object
      * @param ExpressionLanguage $expression ExpressionLanguage object
      */

diff --git a/libraries/classes/CentralColumns.php b/libraries/classes/CentralColumns.php
@@ -66,8 +66,6 @@ class CentralColumns
     public $template;
 
     /**
-     * Constructor
-     *
      * @param DatabaseInterface $dbi DatabaseInterface instance
      */
     public function __construct(DatabaseInterface $dbi)

diff --git a/libraries/classes/CheckUserPrivileges.php b/libraries/classes/CheckUserPrivileges.php
@@ -24,8 +24,6 @@ class CheckUserPrivileges
     private $dbi;
 
     /**
-     * Constructor
-     *
      * @param DatabaseInterface $dbi DatabaseInterface object
      */
     public function __construct(DatabaseInterface $dbi)

diff --git a/libraries/classes/Config.php b/libraries/classes/Config.php
@@ -79,8 +79,6 @@ class Config
     public $done = false;
 
     /**
-     * constructor
-     *
      * @param string $source source to read config from
      */
     public function __construct(?string $source = null)

diff --git a/libraries/classes/Config/ConfigFile.php b/libraries/classes/Config/ConfigFile.php
@@ -84,8 +84,6 @@ class ConfigFile
     private $_flattenArrayResult;
 
     /**
-     * Constructor
-     *
      * @param array|null $baseConfig base configuration read from
      *                               {@link PhpMyAdmin\Config::$base_config},
      *                               use only when not in PMA Setup

diff --git a/libraries/classes/Config/Form.php b/libraries/classes/Config/Form.php
@@ -61,7 +61,7 @@ class Form
     private $_configFile;
 
     /**
-     * Constructor, reads default config values
+     * Reads default config values
      *
      * @param string     $formName Form name
      * @param array      $form     Form data

diff --git a/libraries/classes/Config/FormDisplay.php b/libraries/classes/Config/FormDisplay.php
@@ -100,8 +100,6 @@ class FormDisplay
     private $formDisplayTemplate;
 
     /**
-     * Constructor
-     *
      * @param ConfigFile $cf Config file instance
      */
     public function __construct(ConfigFile $cf)

diff --git a/libraries/classes/Config/Forms/BaseForm.php b/libraries/classes/Config/Forms/BaseForm.php
@@ -19,8 +19,6 @@
 abstract class BaseForm extends FormDisplay
 {
     /**
-     * Constructor
-     *
      * @param ConfigFile $cf       Config file instance
      * @param int|null   $serverId 0 if new server, validation; >= 1 if editing a server
      */

diff --git a/libraries/classes/Config/Forms/BaseFormList.php b/libraries/classes/Config/Forms/BaseFormList.php
@@ -62,8 +62,6 @@ public static function get($name)
     }
 
     /**
-     * Constructor
-     *
      * @param ConfigFile $cf Config file instance
      */
     public function __construct(ConfigFile $cf)

diff --git a/libraries/classes/Config/PageSettings.php b/libraries/classes/Config/PageSettings.php
@@ -57,8 +57,6 @@ class PageSettings
     private $userPreferences;
 
     /**
-     * Constructor
-     *
      * @param string $formGroupName The name of config form group to display
      * @param string $elemId        Id of the div containing settings
      */

diff --git a/libraries/classes/Controllers/Database/StructureController.php b/libraries/classes/Controllers/Database/StructureController.php
@@ -75,8 +75,6 @@ class StructureController extends AbstractController
     private $replication;
 
     /**
-     * Constructor
-     *
      * @param Response          $response    Response instance
      * @param DatabaseInterface $dbi         DatabaseInterface instance
      * @param Template          $template    Template object

diff --git a/libraries/classes/Controllers/Table/AbstractController.php b/libraries/classes/Controllers/Table/AbstractController.php
@@ -31,8 +31,6 @@ abstract class AbstractController extends Controller
     protected $table;
 
     /**
-     * Constructor
-     *
      * @param Response          $response Response object
      * @param DatabaseInterface $dbi      DatabaseInterface object
      * @param Template          $template Template object

diff --git a/libraries/classes/Controllers/Table/SearchController.php b/libraries/classes/Controllers/Table/SearchController.php
@@ -78,8 +78,6 @@ class SearchController extends AbstractController
     private $relation;
 
     /**
-     * Constructor
-     *
      * @param Response          $response Response object
      * @param DatabaseInterface $dbi      DatabaseInterface object
      * @param Template          $template Template object

diff --git a/libraries/classes/Controllers/Table/StructureController.php b/libraries/classes/Controllers/Table/StructureController.php
@@ -71,8 +71,6 @@ class StructureController extends AbstractController
     private $transformations;
 
     /**
-     * StructureController constructor
-     *
      * @param Response          $response        Response object
      * @param DatabaseInterface $dbi             DatabaseInterface object
      * @param Template          $template        Template object

diff --git a/libraries/classes/CreateAddField.php b/libraries/classes/CreateAddField.php
@@ -23,8 +23,6 @@ class CreateAddField
     private $dbi;
 
     /**
-     * Constructor
-     *
      * @param DatabaseInterface $dbi DatabaseInterface interface
      */
     public function __construct(DatabaseInterface $dbi)

diff --git a/libraries/classes/Database/MultiTableQuery.php b/libraries/classes/Database/MultiTableQuery.php
@@ -59,8 +59,6 @@ class MultiTableQuery
     public $template;
 
     /**
-     * Constructor
-     *
      * @param DatabaseInterface $dbi                DatabaseInterface instance
      * @param Template          $template           Template instance
      * @param string            $dbName             Database name

diff --git a/libraries/classes/Database/Qbe.php b/libraries/classes/Database/Qbe.php
@@ -232,8 +232,6 @@ class Qbe
     public $template;
 
     /**
-     * Public Constructor
-     *
      * @param Relation          $relation        Relation object
      * @param Template          $template        Template object
      * @param DatabaseInterface $dbi             DatabaseInterface object

diff --git a/libraries/classes/Database/Search.php b/libraries/classes/Database/Search.php
@@ -96,8 +96,6 @@ class Search
     public $template;
 
     /**
-     * Public Constructor
-     *
      * @param DatabaseInterface $dbi      DatabaseInterface object
      * @param string            $db       Database name
      * @param Template          $template Template object

diff --git a/libraries/classes/DatabaseInterface.php b/libraries/classes/DatabaseInterface.php
@@ -115,8 +115,6 @@ class DatabaseInterface implements DbalInterface
     private $relation;
 
     /**
-     * Constructor
-     *
      * @param DbiExtension $ext Object to be used for database queries
      */
     public function __construct(DbiExtension $ext)

diff --git a/libraries/classes/Display/Export.php b/libraries/classes/Display/Export.php
@@ -43,9 +43,6 @@ class Export
      */
     public $template;
 
-    /**
-     * Constructor
-     */
     public function __construct()
     {
         $this->relation = new Relation($GLOBALS['dbi']);

diff --git a/libraries/classes/Display/Results.php b/libraries/classes/Display/Results.php
@@ -209,8 +209,6 @@ class Results
     public $template;
 
     /**
-     * Constructor for PhpMyAdmin\Display\Results class
-     *
      * @param string $db        the database name
      * @param string $table     the table name
      * @param int    $server    the server id

diff --git a/libraries/classes/Error.php b/libraries/classes/Error.php
@@ -93,8 +93,6 @@ class Error extends Message
     protected $hide_location = false;
 
     /**
-     * Constructor
-     *
      * @param integer $errno   error number
      * @param string  $errstr  error message
      * @param string  $errfile file

diff --git a/libraries/classes/ErrorHandler.php b/libraries/classes/ErrorHandler.php
@@ -36,9 +36,6 @@ class ErrorHandler
      */
     protected $error_reporting = 0;
 
-    /**
-     * Constructor - set PHP error handler
-     */
     public function __construct()
     {
         /**

diff --git a/libraries/classes/ErrorReport.php b/libraries/classes/ErrorReport.php
@@ -41,8 +41,6 @@ class ErrorReport
     public $template;
 
     /**
-     * Constructor
-     *
      * @param HttpRequest $httpRequest HttpRequest instance
      * @param Relation    $relation    Relation instance
      * @param Template    $template    Template instance

diff --git a/libraries/classes/File.php b/libraries/classes/File.php
@@ -83,8 +83,6 @@ class File
     private $zipExtension;
 
     /**
-     * constructor
-     *
      * @param boolean|string $name file name or false
      *
      * @access public

diff --git a/libraries/classes/Gis/GisVisualization.php b/libraries/classes/Gis/GisVisualization.php
@@ -119,7 +119,7 @@ public function hasSrid()
     }
 
     /**
-     * Constructor. Stores user specified options.
+     * Stores user specified options.
      *
      * @param string     $sql_query SQL to fetch raw data for visualization
      * @param array      $options   Users specified options

diff --git a/libraries/classes/Import.php b/libraries/classes/Import.php
@@ -42,9 +42,6 @@ class Import
     public const SIZES = 1;
     public const FORMATTEDSQL = 2;
 
-    /**
-     * Import constructor.
-     */
     public function __construct()
     {
         $GLOBALS['cfg']['Server']['DisableIS'] = false;

diff --git a/libraries/classes/Index.php b/libraries/classes/Index.php
@@ -110,8 +110,6 @@ class Index
     private $_parser = null;
 
     /**
-     * Constructor
-     *
      * @param array $params parameters
      */
     public function __construct(array $params = [])

diff --git a/libraries/classes/IndexColumn.php b/libraries/classes/IndexColumn.php
@@ -59,8 +59,6 @@ class IndexColumn
     private $_cardinality = null;
 
     /**
-     * Constructor
-     *
      * @param array $params an array containing the parameters of the index column
      */
     public function __construct(array $params = [])

diff --git a/libraries/classes/InsertEdit.php b/libraries/classes/InsertEdit.php
@@ -47,8 +47,6 @@ class InsertEdit
     public $template;
 
     /**
-     * Constructor
-     *
      * @param DatabaseInterface $dbi DatabaseInterface instance
      */
     public function __construct(DatabaseInterface $dbi)

diff --git a/libraries/classes/ListDatabase.php b/libraries/classes/ListDatabase.php
@@ -24,9 +24,6 @@
  */
 class ListDatabase extends ListAbstract
 {
-    /**
-     * Constructor
-     */
     public function __construct()
     {
         parent::__construct();

diff --git a/libraries/classes/Message.php b/libraries/classes/Message.php
@@ -128,8 +128,6 @@ class Message
     protected $addedMessages = [];
 
     /**
-     * Constructor
-     *
      * @param string  $string   The message to be displayed
      * @param integer $number   A numeric representation of the type of message
      * @param array   $params   An array of parameters to use in the message

diff --git a/libraries/classes/MultSubmits.php b/libraries/classes/MultSubmits.php
@@ -33,9 +33,6 @@ class MultSubmits
      */
     private $operations;
 
-    /**
-     * MultSubmits constructor.
-     */
     public function __construct()
     {
         $this->transformations = new Transformations();

diff --git a/libraries/classes/Normalization.php b/libraries/classes/Normalization.php
@@ -42,8 +42,6 @@ class Normalization
     public $template;
 
     /**
-     * Constructor
-     *
      * @param DatabaseInterface $dbi             DatabaseInterface instance
      * @param Relation          $relation        Relation instance
      * @param Transformations   $transformations Transformations instance

diff --git a/libraries/classes/Plugins/Auth/AuthenticationCookie.php b/libraries/classes/Plugins/Auth/AuthenticationCookie.php
@@ -41,9 +41,6 @@ class AuthenticationCookie extends AuthenticationPlugin
      */
     private $_use_openssl;
 
-    /**
-     * Constructor
-     */
     public function __construct()
     {
         parent::__construct();

diff --git a/libraries/classes/Plugins/AuthenticationPlugin.php b/libraries/classes/Plugins/AuthenticationPlugin.php
@@ -51,9 +51,6 @@ abstract class AuthenticationPlugin
      */
     public $template;
 
-    /**
-     * AuthenticationPlugin constructor.
-     */
     public function __construct()
     {
         $this->ipAllowDeny = new IpAllowDeny();

diff --git a/libraries/classes/Plugins/Export/ExportCodegen.php b/libraries/classes/Plugins/Export/ExportCodegen.php
@@ -39,9 +39,6 @@ class ExportCodegen extends ExportPlugin
      */
     private $_cgHandlers;
 
-    /**
-     * Constructor
-     */
     public function __construct()
     {
         parent::__construct();

diff --git a/libraries/classes/Plugins/Export/ExportCsv.php b/libraries/classes/Plugins/Export/ExportCsv.php
@@ -26,9 +26,6 @@
  */
 class ExportCsv extends ExportPlugin
 {
-    /**
-     * Constructor
-     */
     public function __construct()
     {
         parent::__construct();

diff --git a/libraries/classes/Plugins/Export/ExportHtmlword.php b/libraries/classes/Plugins/Export/ExportHtmlword.php
@@ -27,9 +27,6 @@
  */
 class ExportHtmlword extends ExportPlugin
 {
-    /**
-     * Constructor
-     */
     public function __construct()
     {
         parent::__construct();

diff --git a/libraries/classes/Plugins/Export/ExportJson.php b/libraries/classes/Plugins/Export/ExportJson.php
@@ -27,9 +27,6 @@ class ExportJson extends ExportPlugin
 {
     private $first = true;
 
-    /**
-     * Constructor
-     */
     public function __construct()
     {
         parent::__construct();

diff --git a/libraries/classes/Plugins/Export/ExportLatex.php b/libraries/classes/Plugins/Export/ExportLatex.php
@@ -27,9 +27,6 @@
  */
 class ExportLatex extends ExportPlugin
 {
-    /**
-     * Constructor
-     */
     public function __construct()
     {
         parent::__construct();

diff --git a/libraries/classes/Plugins/Export/ExportMediawiki.php b/libraries/classes/Plugins/Export/ExportMediawiki.php
@@ -27,9 +27,6 @@
  */
 class ExportMediawiki extends ExportPlugin
 {
-    /**
-     * Constructor
-     */
     public function __construct()
     {
         parent::__construct();