http://www.mediawiki.org/wiki/Special:Code/MediaWiki/60809
Revision: 60809 Author: ialex Date: 2010-01-07 21:44:06 +0000 (Thu, 07 Jan 2010) Log Message: ----------- * Added some basic doc for the DoubleRedirectJob class * Fixed some doxygen warnings Modified Paths: -------------- trunk/phase3/includes/DoubleRedirectJob.php trunk/phase3/includes/HTMLCacheUpdate.php Modified: trunk/phase3/includes/DoubleRedirectJob.php =================================================================== --- trunk/phase3/includes/DoubleRedirectJob.php 2010-01-07 21:31:33 UTC (rev 60808) +++ trunk/phase3/includes/DoubleRedirectJob.php 2010-01-07 21:44:06 UTC (rev 60809) @@ -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 @@ /** * 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 ); Modified: trunk/phase3/includes/HTMLCacheUpdate.php =================================================================== --- trunk/phase3/includes/HTMLCacheUpdate.php 2010-01-07 21:31:33 UTC (rev 60808) +++ trunk/phase3/includes/HTMLCacheUpdate.php 2010-01-07 21:44:06 UTC (rev 60809) @@ -214,9 +214,9 @@ /** * 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 ); _______________________________________________ MediaWiki-CVS mailing list MediaWiki-CVS@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs