Added more JobRunner docs

Change-Id: I4fbb947a2fc2b5f325dff97127bf39edf18f0e13

diff --git a/includes/jobqueue/JobRunner.php b/includes/jobqueue/JobRunner.php
index 9a4073f..c5e7f2e 100644 (file)
--- a/includes/jobqueue/JobRunner.php
+++ b/includes/jobqueue/JobRunner.php
@@ -54,7 +54,11 @@ class JobRunner {
         * This method outputs status information only if a debug handler was set.
         * Any exceptions are caught and logged, but are not reported as output.
         *
-        * @param array $options
+        * @param array $options Map of parameters:
+        *    - type     : the job type (or false for the default types)
+        *    - maxJobs  : maximum number of jobs to run
+        *    - maxTime  : maximum time in seconds before stopping
+        *    - throttle : whether to respect job backoff configuration
         * @return array Summary response that can easily be JSON serialized
         */
        public function run( array $options ) {