From: Alangi Derick <alangiderick@gmail.com>
Date: Mon, 3 Dec 2018 12:17:08 +0000 (+0100)
Subject: jobqueue: Add PHPDoc param annotation for __construct() method
X-Git-Tag: 1.34.0-rc.0~3315
X-Git-Url: https://git.cyclocoop.org/%27.WWW_URL.%27admin/?a=commitdiff_plain;h=feb9456bbc2dc2cbdc799a849fe259dbbc0c5774;p=lhc%2Fweb%2Fwiklou.git

jobqueue: Add PHPDoc param annotation for __construct() method

Document $parserCache, $title and $params for the constructor method
and minor typo fix newSpec() method.

Change-Id: I5968ee5bfe614da6f6dc8d7e0405799aa00b6127
---

diff --git a/includes/jobqueue/jobs/CategoryMembershipChangeJob.php b/includes/jobqueue/jobs/CategoryMembershipChangeJob.php
index 1c7647c28f..b64c87aea7 100644
--- a/includes/jobqueue/jobs/CategoryMembershipChangeJob.php
+++ b/includes/jobqueue/jobs/CategoryMembershipChangeJob.php
@@ -47,7 +47,7 @@ class CategoryMembershipChangeJob extends Job {
 	private $parserCache;
 
 	/**
-	 * @param Title $title The title of the page for which to update category emmbership.
+	 * @param Title $title The title of the page for which to update category membership.
 	 * @param string $revisionTimestamp The timestamp of the new revision that triggered the job.
 	 * @return JobSpecification
 	 */
@@ -66,6 +66,9 @@ class CategoryMembershipChangeJob extends Job {
 	/**
 	 * Constructor for use by the Job Queue infrastructure.
 	 * @note Don't call this when queueing a new instance, use newSpec() instead.
+	 * @param ParserCache $parserCache Cache outputs of PHP parser.
+	 * @param Title $title Title of the categorized page.
+	 * @param array $params Such latest revision instance of the categorized page.
 	 */
 	public function __construct( ParserCache $parserCache, Title $title, array $params ) {
 		parent::__construct( 'categoryMembershipChange', $title, $params );