From: Alexandre Emsenhuber <ialex@users.mediawiki.org>
Date: Thu, 7 Jan 2010 21:44:06 +0000 (+0000)
Subject: * Added some basic doc for the DoubleRedirectJob class
X-Git-Tag: 1.31.0-rc.0~38365
X-Git-Url: http://git.cyclocoop.org/%24image?a=commitdiff_plain;h=88dc02a207f3b1379a50212d4295f3463ef84c92;p=lhc%2Fweb%2Fwiklou.git

* Added some basic doc for the DoubleRedirectJob class
* Fixed some doxygen warnings
---

diff --git a/includes/DoubleRedirectJob.php b/includes/DoubleRedirectJob.php
index 889beecfe7..0857408a01 100644
--- a/includes/DoubleRedirectJob.php
+++ b/includes/DoubleRedirectJob.php
@@ -1,13 +1,19 @@
 <?php
 
+/**
+ * Job to fix double redirects after moving a page
+ *
+ * @ingroup JobQueue
+ */
 class DoubleRedirectJob extends Job {
 	var $reason, $redirTitle, $destTitleText;
 	static $user;
 
 	/** 
 	 * Insert jobs into the job queue to fix redirects to the given title
-	 * @param string $type The reason for the fix, see message double-redirect-fixed-<reason>
-	 * @param Title $redirTitle The title which has changed, redirects pointing to this title are fixed
+	 * @param $reason String: the reason for the fix, see message double-redirect-fixed-<reason>
+	 * @param $redirTitle Title: the title which has changed, redirects pointing to this title are fixed
+	 * @param $destTitle Not used
 	 */
 	public static function fixRedirects( $reason, $redirTitle, $destTitle = false ) {
 		# Need to use the master to get the redirect table updated in the same transaction
@@ -116,7 +122,7 @@ class DoubleRedirectJob extends Job {
 
 	/**
 	 * Get the final destination of a redirect
-	 * Returns false if the specified title is not a redirect, or if it is a circular redirect
+	 * @return false if the specified title is not a redirect, or if it is a circular redirect
 	 */
 	public static function getFinalDestination( $title ) {
 		$dbw = wfGetDB( DB_MASTER );
diff --git a/includes/HTMLCacheUpdate.php b/includes/HTMLCacheUpdate.php
index 7c4731b0ad..99609fe00c 100644
--- a/includes/HTMLCacheUpdate.php
+++ b/includes/HTMLCacheUpdate.php
@@ -214,9 +214,9 @@ class HTMLCacheUpdateJob extends Job {
 
 	/**
 	 * Construct a job
-	 * @param Title $title The title linked to
-	 * @param array $params Job parameters (table, start and end page_ids)
-	 * @param integer $id job_id
+	 * @param $title Title: the title linked to
+	 * @param $params Array: job parameters (table, start and end page_ids)
+	 * @param $job_id Integer
 	 */
 	function __construct( $title, $params, $id = 0 ) {
 		parent::__construct( 'htmlCacheUpdate', $title, $params, $id );