From a643b8729509aea8b8977b8cf53a86851dff63e9 Mon Sep 17 00:00:00 2001 From: Alexandre Emsenhuber Date: Sun, 4 Jul 2010 14:41:26 +0000 Subject: [PATCH] Fixed some doxygen warnings --- includes/db/Database.php | 41 +++++++++++++++++----------------- includes/db/DatabaseOracle.php | 4 ++-- includes/db/DatabaseSqlite.php | 5 +++-- 3 files changed, 26 insertions(+), 24 deletions(-) diff --git a/includes/db/Database.php b/includes/db/Database.php index c3ef663d83..54613983de 100644 --- a/includes/db/Database.php +++ b/includes/db/Database.php @@ -971,12 +971,12 @@ abstract class DatabaseBase { * so use sparingly * Takes same arguments as Database::select() * - * @param string $table table name - * @param array $vars unused - * @param array $conds filters on the table - * @param string $fname function name for profiling - * @param array $options options for select - * @return int row count + * @param $table String: table name + * @param $vars Array: unused + * @param $conds Array: filters on the table + * @param $fname String: function name for profiling + * @param $options Array: options for select + * @return Integer: row count */ public function estimateRowCount( $table, $vars='*', $conds='', $fname = 'Database::estimateRowCount', $options = array() ) { $rows = 0; @@ -1017,10 +1017,11 @@ abstract class DatabaseBase { /** * Determines whether a field exists in a table - * @param $table: table name - * @param $filed: filed to check on that table - * @param $fname: calling function name (optional) - * @return bool: whether $table has filed $field + * + * @param $table String: table name + * @param $field String: filed to check on that table + * @param $fname String: calling function name (optional) + * @return Boolean: whether $table has filed $field */ function fieldExists( $table, $field, $fname = 'Database::fieldExists' ) { $info = $this->fieldInfo( $table, $field ); @@ -1267,10 +1268,10 @@ abstract class DatabaseBase { * Build a partial where clause from a 2-d array such as used for LinkBatch. * The keys on each level may be either integers or strings. * - * @param array $data organized as 2-d array(baseKeyVal => array(subKeyVal => , ...), ...) - * @param string $baseKey field name to match the base-level keys to (eg 'pl_namespace') - * @param string $subKey field name to match the sub-level keys to (eg 'pl_title') - * @return mixed string SQL fragment, or false if no items in array. + * @param $data Array: organized as 2-d array(baseKeyVal => array(subKeyVal => , ...), ...) + * @param $baseKey String: field name to match the base-level keys to (eg 'pl_namespace') + * @param $subKey String: field name to match the sub-level keys to (eg 'pl_title') + * @return Mixed: string SQL fragment, or false if no items in array. */ function makeWhereFrom2d( $data, $baseKey, $subKey ) { $conds = array(); @@ -2021,6 +2022,7 @@ abstract class DatabaseBase { * @param $oldName String: name of table whose structure should be copied * @param $newName String: name of table to be created * @param $temporary Boolean: whether the new table should be temporary + * @param $fname String: calling function name * @return Boolean: true if operation was successful */ function duplicateTableStructure( $oldName, $newName, $temporary = false, $fname = 'Database::duplicateTableStructure' ) { @@ -2313,9 +2315,10 @@ abstract class DatabaseBase { * Abstracted from Filestore::lock() so child classes can implement for * their own needs. * - * @param $lockName String: Name of lock to aquire - * @param $method String: Name of method calling us - * @return bool + * @param $lockName String: name of lock to aquire + * @param $method String: name of method calling us + * @param $timeout Integer: timeout + * @return Boolean */ public function lock( $lockName, $method, $timeout = 5 ) { return true; @@ -2373,7 +2376,7 @@ abstract class DatabaseBase { * * This is a MySQL-specific feature. * - * @param mixed $value true for allow, false for deny, or "default" to restore the initial value + * @param $value Mixed: true for allow, false for deny, or "default" to restore the initial value */ public function setBigSelects( $value = true ) { // no-op @@ -2770,7 +2773,6 @@ class ResultWrapper implements Iterator { * Fields can be retrieved with $row->fieldname, with fields acting like * member variables. * - * @param $res SQL result object as returned from Database::query(), etc. * @return MySQL row object * @throws DBUnexpectedError Thrown if the database returns an error */ @@ -2782,7 +2784,6 @@ class ResultWrapper implements Iterator { * Fetch the next row from the given result object, in associative array * form. Fields are retrieved with $row['fieldname']. * - * @param $res SQL result object as returned from Database::query(), etc. * @return MySQL row object * @throws DBUnexpectedError Thrown if the database returns an error */ diff --git a/includes/db/DatabaseOracle.php b/includes/db/DatabaseOracle.php index 9eb9e79ad8..aab5f0331d 100644 --- a/includes/db/DatabaseOracle.php +++ b/includes/db/DatabaseOracle.php @@ -850,8 +850,8 @@ class DatabaseOracle extends DatabaseBase { * For internal calls. Use fieldInfo for normal usage. * Returns false if the field doesn't exist * - * @param Array $table - * @param String $field + * @param $table Array + * @param $field String */ private function fieldInfoMulti( $table, $field ) { $tableWhere = ''; diff --git a/includes/db/DatabaseSqlite.php b/includes/db/DatabaseSqlite.php index 535b5c4a53..f0de5df010 100644 --- a/includes/db/DatabaseSqlite.php +++ b/includes/db/DatabaseSqlite.php @@ -151,8 +151,9 @@ class DatabaseSqlite extends DatabaseBase { /** * Attaches external database to our connection, see http://sqlite.org/lang_attach.html * for details. - * @param $name: Database name to be used in queries like SELECT foo FROM dbname.table - * @param $file: Database file name. If omitted, will be generated using $name and $wgSQLiteDataDir + * @param $name String: database name to be used in queries like SELECT foo FROM dbname.table + * @param $file String: database file name. If omitted, will be generated using $name and $wgSQLiteDataDir + * @param $fname String: calling function name */ function attachDatabase( $name, $file = false, $fname = 'DatabaseSqlite::attachDatabase' ) { global $wgSQLiteDataDir; -- 2.20.1