From e0dde9034f5ba66331ca5d236851d6a08fa4e0d1 Mon Sep 17 00:00:00 2001 From: Jakub Vrana Date: Sat, 22 Mar 2025 21:04:58 +0100 Subject: [PATCH] Doc-comments: Use consistent style --- adminer/drivers/mysql.inc.php | 2 +- adminer/include/adminer.inc.php | 10 +++++----- adminer/include/auth.inc.php | 2 +- adminer/static/editing.js | 2 +- adminer/static/functions.js | 2 +- plugins/drivers/elastic.php | 2 +- plugins/dump-alter.php | 2 +- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/adminer/drivers/mysql.inc.php b/adminer/drivers/mysql.inc.php index 7a288c69..b95fb886 100644 --- a/adminer/drivers/mysql.inc.php +++ b/adminer/drivers/mysql.inc.php @@ -92,7 +92,7 @@ if (!defined('Adminer\DRIVER')) { return (bool) $this->link; } - /** Sets the client character set + /** Set the client character set * @param string * @return bool */ diff --git a/adminer/include/adminer.inc.php b/adminer/include/adminer.inc.php index 9fcd06ed..728ce503 100644 --- a/adminer/include/adminer.inc.php +++ b/adminer/include/adminer.inc.php @@ -773,7 +773,7 @@ class Adminer { return unconvert_field($field, $return); } - /** Returns export output options + /** Return export output options * @return array */ function dumpOutput() { @@ -784,7 +784,7 @@ class Adminer { return $return; } - /** Returns export format options + /** Return export format options * @return array empty to disable export */ function dumpFormat() { @@ -984,7 +984,7 @@ class Adminer { return true; } - /** Prints navigation after Adminer title + /** Print navigation after Adminer title * @param string can be "auth" if there is no database connection, "db" if there is no database selected, "ns" with invalid schema * @return null */ @@ -1075,7 +1075,7 @@ class Adminer { ); } - /** Prints databases list in menu + /** Print databases list in menu * @param string * @return null */ @@ -1110,7 +1110,7 @@ class Adminer { echo "

\n"; } - /** Prints table list in menu + /** Print table list in menu * @param array result of table_status('', true) * @return null */ diff --git a/adminer/include/auth.inc.php b/adminer/include/auth.inc.php index f53a9198..a3c72b61 100644 --- a/adminer/include/auth.inc.php +++ b/adminer/include/auth.inc.php @@ -123,7 +123,7 @@ function unset_permanent() { cookie("adminer_permanent", implode(" ", $permanent)); } -/** Renders an error message and a login form +/** Render an error message and a login form * @param string plain text * @return null exits */ diff --git a/adminer/static/editing.js b/adminer/static/editing.js index 94dec188..ea1f13dc 100644 --- a/adminer/static/editing.js +++ b/adminer/static/editing.js @@ -641,7 +641,7 @@ function indexesAddColumn(prefix) { -/** Updates the form action +/** Update the form action * @param HTMLFormElement * @param string */ diff --git a/adminer/static/functions.js b/adminer/static/functions.js index 4d9d627a..048d2608 100644 --- a/adminer/static/functions.js +++ b/adminer/static/functions.js @@ -405,7 +405,7 @@ function selectSearchSearch() { -/** Toggles column context menu +/** Toggle column context menu * @param [string] extra class name * @this HTMLElement */ diff --git a/plugins/drivers/elastic.php b/plugins/drivers/elastic.php index 348ab8d2..dd66077f 100644 --- a/plugins/drivers/elastic.php +++ b/plugins/drivers/elastic.php @@ -52,7 +52,7 @@ if (isset($_GET["elastic"])) { return $return; } - /** Performs query relative to actual selected DB + /** Perform query relative to actual selected DB * @param string $path * @param array|null $content * @param string $method diff --git a/plugins/dump-alter.php b/plugins/dump-alter.php index 1dd21ef1..13b4653e 100644 --- a/plugins/dump-alter.php +++ b/plugins/dump-alter.php @@ -1,6 +1,6 @@