r60809 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r60808‎ | r60809 | r60810 >
Date:21:44, 7 January 2010
Author:ialex
Status:ok
Tags:
Comment:
* Added some basic doc for the DoubleRedirectJob class
* Fixed some doxygen warnings
Modified paths:
  • /trunk/phase3/includes/DoubleRedirectJob.php (modified) (history)
  • /trunk/phase3/includes/HTMLCacheUpdate.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/DoubleRedirectJob.php
@@ -1,13 +1,19 @@
22 <?php
33
 4+/**
 5+ * Job to fix double redirects after moving a page
 6+ *
 7+ * @ingroup JobQueue
 8+ */
49 class DoubleRedirectJob extends Job {
510 var $reason, $redirTitle, $destTitleText;
611 static $user;
712
813 /**
914 * Insert jobs into the job queue to fix redirects to the given title
10 - * @param string $type The reason for the fix, see message double-redirect-fixed-<reason>
11 - * @param Title $redirTitle The title which has changed, redirects pointing to this title are fixed
 15+ * @param $reason String: the reason for the fix, see message double-redirect-fixed-<reason>
 16+ * @param $redirTitle Title: the title which has changed, redirects pointing to this title are fixed
 17+ * @param $destTitle Not used
1218 */
1319 public static function fixRedirects( $reason, $redirTitle, $destTitle = false ) {
1420 # Need to use the master to get the redirect table updated in the same transaction
@@ -116,7 +122,7 @@
117123
118124 /**
119125 * Get the final destination of a redirect
120 - * Returns false if the specified title is not a redirect, or if it is a circular redirect
 126+ * @return false if the specified title is not a redirect, or if it is a circular redirect
121127 */
122128 public static function getFinalDestination( $title ) {
123129 $dbw = wfGetDB( DB_MASTER );
Index: trunk/phase3/includes/HTMLCacheUpdate.php
@@ -214,9 +214,9 @@
215215
216216 /**
217217 * Construct a job
218 - * @param Title $title The title linked to
219 - * @param array $params Job parameters (table, start and end page_ids)
220 - * @param integer $id job_id
 218+ * @param $title Title: the title linked to
 219+ * @param $params Array: job parameters (table, start and end page_ids)
 220+ * @param $job_id Integer
221221 */
222222 function __construct( $title, $params, $id = 0 ) {
223223 parent::__construct( 'htmlCacheUpdate', $title, $params, $id );

Follow-up revisions

RevisionCommit summaryAuthorDate
r61127Fix for r60809: wrong argument nameialex15:02, 16 January 2010

Status & tagging log