Skip to content

Commit 4784606

Browse files
committed
Remove some useless comments
Signed-off-by: Maurício Meneghini Fauth <mauricio@fauth.dev>
1 parent 4ff3724 commit 4784606

52 files changed

Lines changed: 48 additions & 159 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

libraries/classes/Advisory/Advisor.php

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,6 @@ class Advisor
5151
'errors' => [],
5252
];
5353

54-
/**
55-
* @param DatabaseInterface $dbi DatabaseInterface object
56-
* @param ExpressionLanguage $expression ExpressionLanguage object
57-
*/
5854
public function __construct(private DatabaseInterface $dbi, private ExpressionLanguage $expression)
5955
{
6056
/**

libraries/classes/Bookmark.php

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ public function getVariableCount(): int
154154
/**
155155
* Replace the placeholders in the bookmark query with variables
156156
*
157-
* @param array $variables array of variables
157+
* @param array $variables
158158
*
159159
* @return string query with variables applied
160160
*/
@@ -228,9 +228,8 @@ protected static function createFromRow(DatabaseInterface $dbi, array $row): Boo
228228
/**
229229
* Gets the list of bookmarks defined for the current database
230230
*
231-
* @param DatabaseInterface $dbi DatabaseInterface object
232-
* @param string $user Current user
233-
* @param string|false $db the current database name or false
231+
* @param string $user Current user
232+
* @param string|false $db the current database name or false
234233
*
235234
* @return Bookmark[] the bookmarks list
236235
*/
@@ -268,14 +267,13 @@ public static function getList(
268267
/**
269268
* Retrieve a specific bookmark
270269
*
271-
* @param DatabaseInterface $dbi DatabaseInterface object
272-
* @param string $user Current user
273-
* @param DatabaseName $db the current database name
274-
* @param int|string $id an identifier of the bookmark to get
275-
* @param string $id_field which field to look up the identifier
276-
* @param bool $action_bookmark_all true: get all bookmarks regardless
277-
* of the owning user
278-
* @param bool $exact_user_match whether to ignore bookmarks with no user
270+
* @param string $user Current user
271+
* @param DatabaseName $db the current database name
272+
* @param int|string $id an identifier of the bookmark to get
273+
* @param string $id_field which field to look up the identifier
274+
* @param bool $action_bookmark_all true: get all bookmarks regardless
275+
* of the owning user
276+
* @param bool $exact_user_match whether to ignore bookmarks with no user
279277
*
280278
* @return Bookmark|null the bookmark
281279
*/

libraries/classes/BrowseForeigners.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,6 @@ class BrowseForeigners
3030
/** @var Template */
3131
public $template;
3232

33-
/**
34-
* @param Template $template Template object
35-
*/
3633
public function __construct(Template $template)
3734
{
3835
$this->template = $template;

libraries/classes/Charsets.php

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,7 @@ class Charsets
7171
/**
7272
* Loads charset data from the server
7373
*
74-
* @param DatabaseInterface $dbi DatabaseInterface instance
75-
* @param bool $disableIs Disable use of INFORMATION_SCHEMA
74+
* @param bool $disableIs Disable use of INFORMATION_SCHEMA
7675
*/
7776
private static function loadCharsets(DatabaseInterface $dbi, bool $disableIs): void
7877
{
@@ -104,8 +103,7 @@ private static function loadCharsets(DatabaseInterface $dbi, bool $disableIs): v
104103
/**
105104
* Loads collation data from the server
106105
*
107-
* @param DatabaseInterface $dbi DatabaseInterface instance
108-
* @param bool $disableIs Disable use of INFORMATION_SCHEMA
106+
* @param bool $disableIs Disable use of INFORMATION_SCHEMA
109107
*/
110108
private static function loadCollations(DatabaseInterface $dbi, bool $disableIs): void
111109
{
@@ -141,8 +139,7 @@ private static function loadCollations(DatabaseInterface $dbi, bool $disableIs):
141139
/**
142140
* Get current server charset
143141
*
144-
* @param DatabaseInterface $dbi DatabaseInterface instance
145-
* @param bool $disableIs Disable use of INFORMATION_SCHEMA
142+
* @param bool $disableIs Disable use of INFORMATION_SCHEMA
146143
*/
147144
public static function getServerCharset(DatabaseInterface $dbi, bool $disableIs): Charset
148145
{
@@ -185,8 +182,7 @@ public static function getServerCharset(DatabaseInterface $dbi, bool $disableIs)
185182
/**
186183
* Get all server charsets
187184
*
188-
* @param DatabaseInterface $dbi DatabaseInterface instance
189-
* @param bool $disableIs Disable use of INFORMATION_SCHEMA
185+
* @param bool $disableIs Disable use of INFORMATION_SCHEMA
190186
*
191187
* @return array<string, Charset>
192188
*/
@@ -200,8 +196,7 @@ public static function getCharsets(DatabaseInterface $dbi, bool $disableIs): arr
200196
/**
201197
* Get all server collations
202198
*
203-
* @param DatabaseInterface $dbi DatabaseInterface instance
204-
* @param bool $disableIs Disable use of INFORMATION_SCHEMA
199+
* @param bool $disableIs Disable use of INFORMATION_SCHEMA
205200
*
206201
* @return array<string, array<string, Collation>>
207202
*/
@@ -213,9 +208,8 @@ public static function getCollations(DatabaseInterface $dbi, bool $disableIs): a
213208
}
214209

215210
/**
216-
* @param DatabaseInterface $dbi DatabaseInterface instance
217-
* @param bool $disableIs Disable use of INFORMATION_SCHEMA
218-
* @param string|null $name Collation name
211+
* @param bool $disableIs Disable use of INFORMATION_SCHEMA
212+
* @param string|null $name Collation name
219213
*/
220214
public static function findCollationByName(
221215
DatabaseInterface $dbi,

libraries/classes/CheckUserPrivileges.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,6 @@
2121
*/
2222
class CheckUserPrivileges
2323
{
24-
/**
25-
* @param DatabaseInterface $dbi DatabaseInterface object
26-
*/
2724
public function __construct(private DatabaseInterface $dbi)
2825
{
2926
}

libraries/classes/Config/FormDisplay.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,6 @@ public function getDisplay(
314314
/**
315315
* Prepares data for input field display and outputs HTML code
316316
*
317-
* @param Form $form Form object
318317
* @param string $field field name as it appears in $form
319318
* @param string $systemPath field path, eg. Servers/1/verbose
320319
* @param string $workPath work path, eg. Servers/4/verbose

libraries/classes/Config/FormDisplayTemplate.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,6 @@ class FormDisplayTemplate
2626
/** @var Template */
2727
public $template;
2828

29-
/**
30-
* @param Config $config Config instance
31-
*/
3229
public function __construct(protected Config $config)
3330
{
3431
$this->template = new Template();

libraries/classes/ConfigStorage/RelationCleanup.php

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ class RelationCleanup
1616
public $relation;
1717

1818
/**
19-
* @param DatabaseInterface $dbi DatabaseInterface object
20-
* @param Relation $relation Relation object
19+
* @param DatabaseInterface $dbi
2120
*/
2221
public function __construct(public $dbi, Relation $relation)
2322
{

libraries/classes/CreateAddField.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,6 @@
2222
*/
2323
class CreateAddField
2424
{
25-
/**
26-
* @param DatabaseInterface $dbi DatabaseInterface interface
27-
*/
2825
public function __construct(private DatabaseInterface $dbi)
2926
{
3027
}

libraries/classes/Database/CentralColumns.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,6 @@ class CentralColumns
6161
/** @var Template */
6262
public $template;
6363

64-
/**
65-
* @param DatabaseInterface $dbi DatabaseInterface instance
66-
*/
6764
public function __construct(private DatabaseInterface $dbi)
6865
{
6966
$this->user = $GLOBALS['cfg']['Server']['user'];

0 commit comments

Comments
 (0)