[JobQueue] Minor documentation improvements.

Change-Id: I084016531f2c6bc707459c4b670bf02fa72f42d2

diff --git a/includes/job/JobQueue.php b/includes/job/JobQueue.php
index a36cf5b..6ec9b19 100644 (file)
--- a/includes/job/JobQueue.php
+++ b/includes/job/JobQueue.php
@@ -153,7 +153,8 @@ abstract class JobQueue {
        abstract protected function doGetAcquiredCount();
 
        /**
-        * Push a batch of jobs into the queue
+        * Push a batch of jobs into the queue.
+        * This does not require $wgJobClasses to be set for the given job type.
         *
         * @param $jobs array List of Jobs
         * @param $flags integer Bitfield (supports JobQueue::QoS_Atomic)
@@ -179,7 +180,8 @@ abstract class JobQueue {
        abstract protected function doBatchPush( array $jobs, $flags );
 
        /**
-        * Pop a job off of the queue
+        * Pop a job off of the queue.
+        * This requires $wgJobClasses to be set for the given job type.
         *
         * @return Job|bool Returns false on failure
         */

diff --git a/includes/job/JobQueueGroup.php b/includes/job/JobQueueGroup.php
index 10fe51c..b9cad7f 100644 (file)
--- a/includes/job/JobQueueGroup.php
+++ b/includes/job/JobQueueGroup.php
@@ -73,7 +73,8 @@ class JobQueueGroup {
        }
 
        /**
-        * Insert jobs into the respective queues of with the belong
+        * Insert jobs into the respective queues of with the belong.
+        * This inserts the jobs into the queue specified by $wgJobTypeConf.
         *
         * @param $jobs Job|array A single Job or a list of Jobs
         * @throws MWException