r41051 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r41050‎ | r41051 | r41052 >
Date:03:57, 20 September 2008
Author:demon
Status:old
Tags:
Comment:
Lots of doc updates. Documented where I knew what it did. Added @see parameters to all of these wrappers for doxygen.
Modified paths:
  • /trunk/phase3/includes/DatabaseFunctions.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/DatabaseFunctions.php
@@ -154,6 +154,7 @@
155155
156156 /**
157157 * @todo document function
 158+ * @see Database::insertId()
158159 */
159160 function wfInsertId( $dbi = DB_LAST ) {
160161 $db = wfGetDB( $dbi );
@@ -166,6 +167,7 @@
167168
168169 /**
169170 * @todo document function
 171+ * @see Database::dataSeek()
170172 */
171173 function wfDataSeek( $res, $row, $dbi = DB_LAST ) {
172174 $db = wfGetDB( $dbi );
@@ -177,7 +179,8 @@
178180 }
179181
180182 /**
181 - * @todo document function
 183+ * Get the last error number
 184+ * @see Database::lastErrno()
182185 */
183186 function wfLastErrno( $dbi = DB_LAST ) {
184187 $db = wfGetDB( $dbi );
@@ -189,7 +192,8 @@
190193 }
191194
192195 /**
193 - * @todo document function
 196+ * Get the last error
 197+ * @see Database::lastError()
194198 */
195199 function wfLastError( $dbi = DB_LAST ) {
196200 $db = wfGetDB( $dbi );
@@ -201,7 +205,8 @@
202206 }
203207
204208 /**
205 - * @todo document function
 209+ * Get the number of affected rows
 210+ * @see Database::affectedRows()
206211 */
207212 function wfAffectedRows( $dbi = DB_LAST ) {
208213 $db = wfGetDB( $dbi );
@@ -213,7 +218,8 @@
214219 }
215220
216221 /**
217 - * @todo document function
 222+ * Get the last query ran
 223+ * @see Database::lastQuery
218224 */
219225 function wfLastDBquery( $dbi = DB_LAST ) {
220226 $db = wfGetDB( $dbi );
@@ -245,8 +251,8 @@
246252
247253
248254 /**
 255+ * Simple select wrapper, return one field
249256 * @see Database::selectField()
250 - * @todo document function
251257 * @param $table
252258 * @param $var
253259 * @param $cond Default ''
@@ -263,8 +269,8 @@
264270 }
265271
266272 /**
 273+ * Does a given field exist on the specified table?
267274 * @see Database::fieldExists()
268 - * @todo document function
269275 * @param $table
270276 * @param $field
271277 * @param $dbi Default DB_LAST
@@ -280,8 +286,8 @@
281287 }
282288
283289 /**
 290+ * Does the requested index exist on the specified table?
284291 * @see Database::indexExists()
285 - * @todo document function
286292 * @param $table String
287293 * @param $index
288294 * @param $dbi Default DB_LAST
@@ -354,7 +360,8 @@
355361 }
356362
357363 /**
358 - * @todo document function
 364+ * Get fully usable table name
 365+ * @see Database::tableName()
359366 */
360367 function wfTableName( $name, $dbi = DB_LAST ) {
361368 $db = wfGetDB( $dbi );
@@ -367,6 +374,7 @@
368375
369376 /**
370377 * @todo document function
 378+ * @see Database::strencode()
371379 */
372380 function wfStrencode( $s, $dbi = DB_LAST ) {
373381 $db = wfGetDB( $dbi );
@@ -379,6 +387,7 @@
380388
381389 /**
382390 * @todo document function
 391+ * @see Database::nextSequenceValue()
383392 */
384393 function wfNextSequenceValue( $seqName, $dbi = DB_MASTER ) {
385394 $db = wfGetDB( $dbi );
@@ -391,6 +400,7 @@
392401
393402 /**
394403 * @todo document function
 404+ * @see Database::useIndexClause()
395405 */
396406 function wfUseIndexClause( $index, $dbi = DB_SLAVE ) {
397407 $db = wfGetDB( $dbi );

Status & tagging log