1
0
mirror of https://github.com/vrana/adminer.git synced 2025-08-09 16:17:48 +02:00

Doc-comments: Use consistent style

This commit is contained in:
Jakub Vrana
2025-03-22 21:04:58 +01:00
parent 9b162e8291
commit e0dde9034f
7 changed files with 11 additions and 11 deletions

View File

@@ -92,7 +92,7 @@ if (!defined('Adminer\DRIVER')) {
return (bool) $this->link; return (bool) $this->link;
} }
/** Sets the client character set /** Set the client character set
* @param string * @param string
* @return bool * @return bool
*/ */

View File

@@ -773,7 +773,7 @@ class Adminer {
return unconvert_field($field, $return); return unconvert_field($field, $return);
} }
/** Returns export output options /** Return export output options
* @return array * @return array
*/ */
function dumpOutput() { function dumpOutput() {
@@ -784,7 +784,7 @@ class Adminer {
return $return; return $return;
} }
/** Returns export format options /** Return export format options
* @return array empty to disable export * @return array empty to disable export
*/ */
function dumpFormat() { function dumpFormat() {
@@ -984,7 +984,7 @@ class Adminer {
return true; 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 * @param string can be "auth" if there is no database connection, "db" if there is no database selected, "ns" with invalid schema
* @return null * @return null
*/ */
@@ -1075,7 +1075,7 @@ class Adminer {
); );
} }
/** Prints databases list in menu /** Print databases list in menu
* @param string * @param string
* @return null * @return null
*/ */
@@ -1110,7 +1110,7 @@ class Adminer {
echo "</p></form>\n"; echo "</p></form>\n";
} }
/** Prints table list in menu /** Print table list in menu
* @param array result of table_status('', true) * @param array result of table_status('', true)
* @return null * @return null
*/ */

View File

@@ -123,7 +123,7 @@ function unset_permanent() {
cookie("adminer_permanent", implode(" ", $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 * @param string plain text
* @return null exits * @return null exits
*/ */

View File

@@ -641,7 +641,7 @@ function indexesAddColumn(prefix) {
/** Updates the form action /** Update the form action
* @param HTMLFormElement * @param HTMLFormElement
* @param string * @param string
*/ */

View File

@@ -405,7 +405,7 @@ function selectSearchSearch() {
/** Toggles column context menu /** Toggle column context menu
* @param [string] extra class name * @param [string] extra class name
* @this HTMLElement * @this HTMLElement
*/ */

View File

@@ -52,7 +52,7 @@ if (isset($_GET["elastic"])) {
return $return; return $return;
} }
/** Performs query relative to actual selected DB /** Perform query relative to actual selected DB
* @param string $path * @param string $path
* @param array|null $content * @param array|null $content
* @param string $method * @param string $method

View File

@@ -1,6 +1,6 @@
<?php <?php
/** Exports one database (e.g. development) so that it can be synced with other database (e.g. production) /** Export one database (e.g. development) so that it can be synced with other database (e.g. production)
* @link https://www.adminer.org/plugins/#use * @link https://www.adminer.org/plugins/#use
* @author Jakub Vrana, https://www.vrana.cz/ * @author Jakub Vrana, https://www.vrana.cz/
* @license https://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0 * @license https://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0