From 0cb154be245f15708a126f49b46ac6cd7f08ea73 Mon Sep 17 00:00:00 2001
From: Brian Cardarella <bcardarella@gmail.com>
Date: Sat, 23 Jun 2012 14:45:16 -0400
Subject: AsyncMailer documention

---
 actionmailer/lib/action_mailer/async.rb | 2 ++
 actionmailer/lib/action_mailer/base.rb  | 1 +
 2 files changed, 3 insertions(+)

(limited to 'actionmailer')

diff --git a/actionmailer/lib/action_mailer/async.rb b/actionmailer/lib/action_mailer/async.rb
index 6f768ac286..cbadd3dc25 100644
--- a/actionmailer/lib/action_mailer/async.rb
+++ b/actionmailer/lib/action_mailer/async.rb
@@ -26,10 +26,12 @@ module ActionMailer::Async
       actual_message.deliver
     end
 
+    # Will push the message onto the Queue to be processed
     def deliver
       Rails.queue << self
     end
 
+    # The original ActionMailer message
     def actual_message
       @actual_message ||= @mailer_class.send(:new, @method_name, *@args).message
     end
diff --git a/actionmailer/lib/action_mailer/base.rb b/actionmailer/lib/action_mailer/base.rb
index f40b85549e..5686e78dfc 100644
--- a/actionmailer/lib/action_mailer/base.rb
+++ b/actionmailer/lib/action_mailer/base.rb
@@ -456,6 +456,7 @@ module ActionMailer #:nodoc:
         super || action_methods.include?(method.to_s)
       end
 
+      # Will force ActionMailer to push new messages to the Rails.queue
       def async=(truth)
         if truth
           require 'action_mailer/async'
-- 
cgit v1.2.3