From c9a4c2a5ce3eab52e2335362fe643328831a0ac4 Mon Sep 17 00:00:00 2001
From: Cristian Bica <cristian.bica@gmail.com>
Date: Sun, 21 Sep 2014 23:20:23 +0300
Subject: Added RDoc for each Active Job adapter

---
 activejob/lib/active_job/queue_adapters/test_adapter.rb | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

(limited to 'activejob/lib/active_job/queue_adapters/test_adapter.rb')

diff --git a/activejob/lib/active_job/queue_adapters/test_adapter.rb b/activejob/lib/active_job/queue_adapters/test_adapter.rb
index 12ef72310d..e4fdf60008 100644
--- a/activejob/lib/active_job/queue_adapters/test_adapter.rb
+++ b/activejob/lib/active_job/queue_adapters/test_adapter.rb
@@ -1,5 +1,14 @@
 module ActiveJob
   module QueueAdapters
+    # == Test adapter for Active Job
+    #
+    # The test adapter should be used only in testing. Along with
+    # <tt>ActiveJob::TestCase</tt> and <tt>ActiveJob::TestHelper</tt>
+    # it makes a great tool to test your Rails application.
+    #
+    # To use the test adapter set queue_adapter config to +:test+.
+    #
+    #   Rails.application.config.active_job.queue_adapter = :test
     class TestAdapter
       delegate :name, to: :class
       attr_accessor(:perform_enqueued_jobs, :perform_enqueued_at_jobs)
@@ -15,7 +24,7 @@ module ActiveJob
         @performed_jobs ||= []
       end
 
-      def enqueue(job)
+      def enqueue(job) #:nodoc:
         if perform_enqueued_jobs
           performed_jobs << {job: job.class, args: job.arguments, queue: job.queue_name}
           job.perform_now
@@ -24,7 +33,7 @@ module ActiveJob
         end
       end
 
-      def enqueue_at(job, timestamp)
+      def enqueue_at(job, timestamp) #:nodoc:
         if perform_enqueued_at_jobs
           performed_jobs << {job: job.class, args: job.arguments, queue: job.queue_name, at: timestamp}
           job.perform_now
-- 
cgit v1.2.3