r82491 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r82490‎ | r82491 | r82492 >
Date:21:56, 19 February 2011
Author:reedy
Status:ok
Tags:
Comment:
More function documentation
Modified paths:
  • /trunk/phase3/includes/job/DoubleRedirectJob.php (modified) (history)
  • /trunk/phase3/includes/job/JobQueue.php (modified) (history)
  • /trunk/phase3/includes/revisiondelete/RevisionDelete.php (modified) (history)
  • /trunk/phase3/includes/revisiondelete/RevisionDeleteAbstracts.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/revisiondelete/RevisionDelete.php
@@ -10,6 +10,10 @@
1111 var $authorIdField = 'rev_user';
1212 var $authorNameField = 'rev_user_text';
1313
 14+ /**
 15+ * @param $db DatabaseBase
 16+ * @return mixed
 17+ */
1418 public function doQuery( $db ) {
1519 $ids = array_map( 'intval', $this->ids );
1620 return $db->select( array('revision','page'), '*',
@@ -186,6 +190,10 @@
187191 var $authorIdField = 'ar_user';
188192 var $authorNameField = 'ar_user_text';
189193
 194+ /**
 195+ * @param $db DatabaseBase
 196+ * @return mixed
 197+ */
190198 public function doQuery( $db ) {
191199 $timestamps = array();
192200 foreach ( $this->ids as $id ) {
@@ -348,6 +356,10 @@
349357 * Item class for an oldimage table row
350358 */
351359 class RevDel_FileItem extends RevDel_Item {
 360+
 361+ /**
 362+ * @var File
 363+ */
352364 var $file;
353365
354366 public function __construct( $list, $row ) {
Index: trunk/phase3/includes/revisiondelete/RevisionDeleteAbstracts.php
@@ -4,7 +4,13 @@
55 * Abstract base class for a list of deletable items
66 */
77 abstract class RevDel_List {
8 - var $special, $title, $ids, $res, $current;
 8+
 9+ /**
 10+ * @var Title
 11+ */
 12+ var $title;
 13+
 14+ var $special, $ids, $res, $current;
915 var $type = null; // override this
1016 var $idField = null; // override this
1117 var $dateField = false; // override this
@@ -329,7 +335,7 @@
330336
331337 /**
332338 * Do the DB query to iterate through the objects.
333 - * @param $db Database object to use for the query
 339+ * @param $db DatabaseBase object to use for the query
334340 */
335341 abstract public function doQuery( $db );
336342
Index: trunk/phase3/includes/job/JobQueue.php
@@ -16,8 +16,13 @@
1717 * @ingroup JobQueue
1818 */
1919 abstract class Job {
 20+
 21+ /**
 22+ * @var Title
 23+ */
 24+ var $title;
 25+
2026 var $command,
21 - $title,
2227 $params,
2328 $id,
2429 $removeDuplicates,
Index: trunk/phase3/includes/job/DoubleRedirectJob.php
@@ -13,6 +13,10 @@
1414 */
1515 class DoubleRedirectJob extends Job {
1616 var $reason, $redirTitle, $destTitleText;
 17+
 18+ /**
 19+ * @var User
 20+ */
1721 static $user;
1822
1923 /**
@@ -53,6 +57,7 @@
5458 }
5559 Job::batchInsert( $jobs );
5660 }
 61+
5762 function __construct( $title, $params = false, $id = 0 ) {
5863 parent::__construct( 'fixDoubleRedirect', $title, $params, $id );
5964 $this->reason = $params['reason'];

Status & tagging log