| Index: trunk/phase3/includes/db/DatabaseOracle.php |
| — | — | @@ -850,8 +850,8 @@ |
| 851 | 851 | * For internal calls. Use fieldInfo for normal usage. |
| 852 | 852 | * Returns false if the field doesn't exist |
| 853 | 853 | * |
| 854 | | - * @param Array $table |
| 855 | | - * @param String $field |
| | 854 | + * @param $table Array |
| | 855 | + * @param $field String |
| 856 | 856 | */ |
| 857 | 857 | private function fieldInfoMulti( $table, $field ) { |
| 858 | 858 | $tableWhere = ''; |
| Index: trunk/phase3/includes/db/Database.php |
| — | — | @@ -971,12 +971,12 @@ |
| 972 | 972 | * so use sparingly |
| 973 | 973 | * Takes same arguments as Database::select() |
| 974 | 974 | * |
| 975 | | - * @param string $table table name |
| 976 | | - * @param array $vars unused |
| 977 | | - * @param array $conds filters on the table |
| 978 | | - * @param string $fname function name for profiling |
| 979 | | - * @param array $options options for select |
| 980 | | - * @return int row count |
| | 975 | + * @param $table String: table name |
| | 976 | + * @param $vars Array: unused |
| | 977 | + * @param $conds Array: filters on the table |
| | 978 | + * @param $fname String: function name for profiling |
| | 979 | + * @param $options Array: options for select |
| | 980 | + * @return Integer: row count |
| 981 | 981 | */ |
| 982 | 982 | public function estimateRowCount( $table, $vars='*', $conds='', $fname = 'Database::estimateRowCount', $options = array() ) { |
| 983 | 983 | $rows = 0; |
| — | — | @@ -1017,10 +1017,11 @@ |
| 1018 | 1018 | |
| 1019 | 1019 | /** |
| 1020 | 1020 | * Determines whether a field exists in a table |
| 1021 | | - * @param $table: table name |
| 1022 | | - * @param $filed: filed to check on that table |
| 1023 | | - * @param $fname: calling function name (optional) |
| 1024 | | - * @return bool: whether $table has filed $field |
| | 1021 | + * |
| | 1022 | + * @param $table String: table name |
| | 1023 | + * @param $field String: filed to check on that table |
| | 1024 | + * @param $fname String: calling function name (optional) |
| | 1025 | + * @return Boolean: whether $table has filed $field |
| 1025 | 1026 | */ |
| 1026 | 1027 | function fieldExists( $table, $field, $fname = 'Database::fieldExists' ) { |
| 1027 | 1028 | $info = $this->fieldInfo( $table, $field ); |
| — | — | @@ -1267,10 +1268,10 @@ |
| 1268 | 1269 | * Build a partial where clause from a 2-d array such as used for LinkBatch. |
| 1269 | 1270 | * The keys on each level may be either integers or strings. |
| 1270 | 1271 | * |
| 1271 | | - * @param array $data organized as 2-d array(baseKeyVal => array(subKeyVal => <ignored>, ...), ...) |
| 1272 | | - * @param string $baseKey field name to match the base-level keys to (eg 'pl_namespace') |
| 1273 | | - * @param string $subKey field name to match the sub-level keys to (eg 'pl_title') |
| 1274 | | - * @return mixed string SQL fragment, or false if no items in array. |
| | 1272 | + * @param $data Array: organized as 2-d array(baseKeyVal => array(subKeyVal => <ignored>, ...), ...) |
| | 1273 | + * @param $baseKey String: field name to match the base-level keys to (eg 'pl_namespace') |
| | 1274 | + * @param $subKey String: field name to match the sub-level keys to (eg 'pl_title') |
| | 1275 | + * @return Mixed: string SQL fragment, or false if no items in array. |
| 1275 | 1276 | */ |
| 1276 | 1277 | function makeWhereFrom2d( $data, $baseKey, $subKey ) { |
| 1277 | 1278 | $conds = array(); |
| — | — | @@ -2021,6 +2022,7 @@ |
| 2022 | 2023 | * @param $oldName String: name of table whose structure should be copied |
| 2023 | 2024 | * @param $newName String: name of table to be created |
| 2024 | 2025 | * @param $temporary Boolean: whether the new table should be temporary |
| | 2026 | + * @param $fname String: calling function name |
| 2025 | 2027 | * @return Boolean: true if operation was successful |
| 2026 | 2028 | */ |
| 2027 | 2029 | function duplicateTableStructure( $oldName, $newName, $temporary = false, $fname = 'Database::duplicateTableStructure' ) { |
| — | — | @@ -2313,9 +2315,10 @@ |
| 2314 | 2316 | * Abstracted from Filestore::lock() so child classes can implement for |
| 2315 | 2317 | * their own needs. |
| 2316 | 2318 | * |
| 2317 | | - * @param $lockName String: Name of lock to aquire |
| 2318 | | - * @param $method String: Name of method calling us |
| 2319 | | - * @return bool |
| | 2319 | + * @param $lockName String: name of lock to aquire |
| | 2320 | + * @param $method String: name of method calling us |
| | 2321 | + * @param $timeout Integer: timeout |
| | 2322 | + * @return Boolean |
| 2320 | 2323 | */ |
| 2321 | 2324 | public function lock( $lockName, $method, $timeout = 5 ) { |
| 2322 | 2325 | return true; |
| — | — | @@ -2373,7 +2376,7 @@ |
| 2374 | 2377 | * |
| 2375 | 2378 | * This is a MySQL-specific feature. |
| 2376 | 2379 | * |
| 2377 | | - * @param mixed $value true for allow, false for deny, or "default" to restore the initial value |
| | 2380 | + * @param $value Mixed: true for allow, false for deny, or "default" to restore the initial value |
| 2378 | 2381 | */ |
| 2379 | 2382 | public function setBigSelects( $value = true ) { |
| 2380 | 2383 | // no-op |
| — | — | @@ -2770,7 +2773,6 @@ |
| 2771 | 2774 | * Fields can be retrieved with $row->fieldname, with fields acting like |
| 2772 | 2775 | * member variables. |
| 2773 | 2776 | * |
| 2774 | | - * @param $res SQL result object as returned from Database::query(), etc. |
| 2775 | 2777 | * @return MySQL row object |
| 2776 | 2778 | * @throws DBUnexpectedError Thrown if the database returns an error |
| 2777 | 2779 | */ |
| — | — | @@ -2782,7 +2784,6 @@ |
| 2783 | 2785 | * Fetch the next row from the given result object, in associative array |
| 2784 | 2786 | * form. Fields are retrieved with $row['fieldname']. |
| 2785 | 2787 | * |
| 2786 | | - * @param $res SQL result object as returned from Database::query(), etc. |
| 2787 | 2788 | * @return MySQL row object |
| 2788 | 2789 | * @throws DBUnexpectedError Thrown if the database returns an error |
| 2789 | 2790 | */ |
| Index: trunk/phase3/includes/db/DatabaseSqlite.php |
| — | — | @@ -151,8 +151,9 @@ |
| 152 | 152 | /** |
| 153 | 153 | * Attaches external database to our connection, see http://sqlite.org/lang_attach.html |
| 154 | 154 | * for details. |
| 155 | | - * @param $name: Database name to be used in queries like SELECT foo FROM dbname.table |
| 156 | | - * @param $file: Database file name. If omitted, will be generated using $name and $wgSQLiteDataDir |
| | 155 | + * @param $name String: database name to be used in queries like SELECT foo FROM dbname.table |
| | 156 | + * @param $file String: database file name. If omitted, will be generated using $name and $wgSQLiteDataDir |
| | 157 | + * @param $fname String: calling function name |
| 157 | 158 | */ |
| 158 | 159 | function attachDatabase( $name, $file = false, $fname = 'DatabaseSqlite::attachDatabase' ) { |
| 159 | 160 | global $wgSQLiteDataDir; |