From: Aaron Schulz <aschulz@wikimedia.org>
Date: Wed, 9 Jan 2013 00:04:24 +0000 (-0800)
Subject: [JobQueue] Minor doc cleanup.
X-Git-Tag: 1.31.0-rc.0~21102
X-Git-Url: http://git.cyclocoop.org/%7B%24admin_url%7Dmes_infos.php?a=commitdiff_plain;h=f071196cff18820b4863108dc78fc328c120ef4f;p=lhc%2Fweb%2Fwiklou.git

[JobQueue] Minor doc cleanup.

Change-Id: I1059f45f77ff4097a7e72d5210822bb4e5bdeaee
---

diff --git a/includes/job/JobQueue.php b/includes/job/JobQueue.php
index ae80370155..a36cf5bf85 100644
--- a/includes/job/JobQueue.php
+++ b/includes/job/JobQueue.php
@@ -49,19 +49,19 @@ abstract class JobQueue {
 	/**
 	 * Get a job queue object of the specified type.
 	 * $params includes:
-	 *   class    : What job class to use (determines job type)
-	 *   wiki     : wiki ID of the wiki the jobs are for (defaults to current wiki)
-	 *   type     : The name of the job types this queue handles
-	 *   order    : Order that pop() selects jobs, one of "fifo", "timestamp" or "random".
-	 *              If "fifo" is used, the queue will effectively be FIFO. Note that
-	 *              job completion will not appear to be exactly FIFO if there are multiple
-	 *              job runners since jobs can take different times to finish once popped.
-	 *              If "timestamp" is used, the queue will at least be loosely ordered
-	 *              by timestamp, allowing for some jobs to be popped off out of order.
-	 *              If "random" is used, pop() will pick jobs in random order. This might be
-	 *              useful for improving concurrency depending on the queue storage medium.
-	 *   claimTTL : If supported, the queue will recycle jobs that have been popped
-	 *              but not acknowledged as completed after this many seconds.
+	 *   - class    : What job class to use (determines job type)
+	 *   - wiki     : wiki ID of the wiki the jobs are for (defaults to current wiki)
+	 *   - type     : The name of the job types this queue handles
+	 *   - order    : Order that pop() selects jobs, one of "fifo", "timestamp" or "random".
+	 *                If "fifo" is used, the queue will effectively be FIFO. Note that
+	 *                job completion will not appear to be exactly FIFO if there are multiple
+	 *                job runners since jobs can take different times to finish once popped.
+	 *                If "timestamp" is used, the queue will at least be loosely ordered
+	 *                by timestamp, allowing for some jobs to be popped off out of order.
+	 *                If "random" is used, pop() will pick jobs in random order. This might be
+	 *                useful for improving concurrency depending on the queue storage medium.
+	 *   - claimTTL : If supported, the queue will recycle jobs that have been popped
+	 *                but not acknowledged as completed after this many seconds.
 	 *
 	 * Queue classes should throw an exception if they do not support the options given.
 	 *