From 2daaca331caea7ae15b35b8eeb37708e5d8c7de0 Mon Sep 17 00:00:00 2001 From: Aaron Schulz Date: Thu, 10 Jan 2013 13:16:23 -0800 Subject: [PATCH] [JobQueue] Minor documentation improvements. Change-Id: I084016531f2c6bc707459c4b670bf02fa72f42d2 --- includes/job/JobQueue.php | 6 ++++-- includes/job/JobQueueGroup.php | 3 ++- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/includes/job/JobQueue.php b/includes/job/JobQueue.php index a36cf5bf85..6ec9b1925e 100644 --- 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 10fe51c740..b9cad7fc48 100644 --- 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 -- 2.20.1