jobqueue: Add PHPDoc param annotation for __construct() method
authorAlangi Derick <alangiderick@gmail.com>
Mon, 3 Dec 2018 12:17:08 +0000 (13:17 +0100)
committerUmherirrender <umherirrender_de.wp@web.de>
Fri, 7 Dec 2018 18:56:36 +0000 (18:56 +0000)
Document $parserCache, $title and $params for the constructor method
and minor typo fix newSpec() method.

Change-Id: I5968ee5bfe614da6f6dc8d7e0405799aa00b6127

includes/jobqueue/jobs/CategoryMembershipChangeJob.php

index 1c7647c..b64c87a 100644 (file)
@@ -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 );