r71435 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r71434‎ | r71435 | r71436 >
Date:15:58, 22 August 2010
Author:ialex
Status:ok
Tags:
Comment:
Fixed some doxygen warnings
Modified paths:
  • /trunk/phase3/includes/db/DatabaseMssql.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/db/DatabaseMssql.php
@@ -271,15 +271,15 @@
272272 /**
273273 * SELECT wrapper
274274 *
275 - * @param mixed $table Array or string, table name(s) (prefix auto-added)
276 - * @param mixed $vars Array or string, field name(s) to be retrieved
277 - * @param mixed $conds Array or string, condition(s) for WHERE
278 - * @param string $fname Calling function name (use __METHOD__) for logs/profiling
279 - * @param array $options Associative array of options (e.g. array('GROUP BY' => 'page_title')),
280 - * see Database::makeSelectOptions code for list of supported stuff
 275+ * @param $table Mixed: array or string, table name(s) (prefix auto-added)
 276+ * @param $vars Mixed: array or string, field name(s) to be retrieved
 277+ * @param $conds Mixed: array or string, condition(s) for WHERE
 278+ * @param $fname String: calling function name (use __METHOD__) for logs/profiling
 279+ * @param $options Array: associative array of options (e.g. array('GROUP BY' => 'page_title')),
 280+ * see Database::makeSelectOptions code for list of supported stuff
281281 * @param $join_conds Array: Associative array of table join conditions (optional)
282282 * (e.g. array( 'page' => array('LEFT JOIN','page_latest=rev_id') )
283 - * @return mixed Database result resource (feed to Database::fetchObject or whatever), or false on failure
 283+ * @return Mixed: database result resource (feed to Database::fetchObject or whatever), or false on failure
284284 */
285285 function select( $table, $vars, $conds = '', $fname = 'Database::select', $options = array(), $join_conds = array() )
286286 {
@@ -296,13 +296,13 @@
297297 * SELECT wrapper
298298 *
299299 * @param $table Mixed: Array or string, table name(s) (prefix auto-added)
300 - * @param $vars Mixed: Array or string, field name(s) to be retrieved
 300+ * @param $vars Mixed: Array or string, field name(s) to be retrieved
301301 * @param $conds Mixed: Array or string, condition(s) for WHERE
302302 * @param $fname String: Calling function name (use __METHOD__) for logs/profiling
303303 * @param $options Array: Associative array of options (e.g. array('GROUP BY' => 'page_title')),
304 - * see Database::makeSelectOptions code for list of supported stuff
 304+ * see Database::makeSelectOptions code for list of supported stuff
305305 * @param $join_conds Array: Associative array of table join conditions (optional)
306 - * (e.g. array( 'page' => array('LEFT JOIN','page_latest=rev_id') )
 306+ * (e.g. array( 'page' => array('LEFT JOIN','page_latest=rev_id') )
307307 * @return string, the SQL text
308308 */
309309 function selectSQLText( $table, $vars, $conds = '', $fname = 'Database::select', $options = array(), $join_conds = array() ) {
@@ -531,7 +531,7 @@
532532 * themselves. Pass the canonical name to such functions. This is only needed
533533 * when calling query() directly.
534534 *
535 - * @param string $name database table name
 535+ * @param $name String: database table name
536536 */
537537 function tableName( $name ) {
538538 global $wgSharedDB;
@@ -1008,9 +1008,9 @@
10091009 /**
10101010 * @private
10111011 *
1012 - * @param array $options an associative array of options to be turned into
1013 - * an SQL query, valid keys are listed in the function.
1014 - * @return array
 1012+ * @param $options Array: an associative array of options to be turned into
 1013+ * an SQL query, valid keys are listed in the function.
 1014+ * @return Array
10151015 */
10161016 function makeSelectOptions( $options ) {
10171017 $tailOpts = '';

Status & tagging log