From 888b0d06aedaf2e45afed56272db3204689276b1 Mon Sep 17 00:00:00 2001 From: Antoine Musso Date: Thu, 16 May 2013 15:09:27 +0200 Subject: [PATCH] document NullJob example usage This provide a very simple example to use NullJob class for test purposes. Change-Id: I04fa83d4e143451c290f0978ff25b20e9dbe8bef --- includes/job/jobs/NullJob.php | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/includes/job/jobs/NullJob.php b/includes/job/jobs/NullJob.php index d282a8e62b..b6164a5d57 100644 --- a/includes/job/jobs/NullJob.php +++ b/includes/job/jobs/NullJob.php @@ -26,6 +26,22 @@ * in the queue and/or sleep for a brief time period. These can be used * to represent "no-op" jobs or test lock contention and performance. * + * @par Example: + * Inserting a null job in the configured job queue: + * @code + * $ php maintenance/eval.php + * > $queue = JobQueueGroup::singleton(); + * > $job = new NullJob( Title::newMainPage(), array( 'lives' => 10 ) ); + * > $queue->push( $job ); + * @endcode + * You can then confirm the job has been enqueued by using the showJobs.php + * maintenance utility: + * @code + * $ php maintenance/showJobs.php --group + * null: 1 queue; 0 claimed (0 active, 0 abandoned) + * $ + * @endcode + * * @ingroup JobQueue */ class NullJob extends Job { -- 2.20.1