0
@@ -5,12 +5,12 @@ require 'action_mailer/utils'
0
 require 'tmail/net'
0
 
0
 module ActionMailer #:nodoc:
0
-  # ActionMailer allows you to send email from your application using a mailer model and views.
0
+  # Action Mailer allows you to send email from your application using a mailer model and views.
0
   #
0
   #
0
   # = Mailer Models
0
   #
0
-  # To use ActionMailer, you need to create a mailer model.
0
+  # To use Action Mailer, you need to create a mailer model.
0
   #
0
   #   $ script/generate mailer Notifier
0
   #
0
@@ -54,7 +54,7 @@ module ActionMailer #:nodoc:
0
   #
0
   # = Mailer views
0
   #
0
-  # Like ActionController, each mailer class has a corresponding view directory
0
+  # Like Action Controller, each mailer class has a corresponding view directory
0
   # in which each method of the class looks for a template with its name.
0
   # To define a template to be used with a mailing, create an <tt>.erb</tt> file with the same name as the method
0
   # in your mailer model. For example, in the mailer defined above, the template at
0
@@ -157,7 +157,7 @@ module ActionMailer #:nodoc:
0
   #     end
0
   #   end
0
   #
0
-  # Multipart messages can also be used implicitly because ActionMailer will automatically
0
+  # Multipart messages can also be used implicitly because Action Mailer will automatically
0
   # detect and use multipart templates, where each template is named after the name of the action, followed
0
   # by the content type. Each such detected template will be added as separate part to the message.
0
   #
0
@@ -383,8 +383,8 @@ module ActionMailer #:nodoc:
0
 
0
       # Receives a raw email, parses it into an email object, decodes it,
0
       # instantiates a new mailer, and passes the email object to the mailer
0
-      # object's #receive method. If you want your mailer to be able to
0
-      # process incoming messages, you'll need to implement a #receive
0
+      # object's +receive+ method. If you want your mailer to be able to
0
+      # process incoming messages, you'll need to implement a +receive+
0
       # method that accepts the email object as a parameter:
0
       #
0
       #   class MyMailer < ActionMailer::Base
0
@@ -490,7 +490,7 @@ module ActionMailer #:nodoc:
0
     end
0
 
0
     # Delivers a TMail::Mail object. By default, it delivers the cached mail
0
-    # object (from the #create! method). If no cached mail object exists, and
0
+    # object (from the <tt>create!</tt> method). If no cached mail object exists, and
0
     # no alternate has been given as the parameter, this will fail.
0
     def deliver!(mail = @mail)
0
       raise "no mail object available for delivery!" unless mail

0
@@ -34,7 +34,7 @@ module ActionMailer
0
       #   helper FooHelper
0
       # includes FooHelper in the template class.
0
       #   helper { def foo() "#{bar} is the very best" end }
0
-      # evaluates the block in the template class, adding method #foo.
0
+      # evaluates the block in the template class, adding method +foo+.
0
       #   helper(:three, BlindHelper) { def mice() 'mice' end }
0
       # does all three.
0
       def helper(*args, &block)

0
@@ -5,7 +5,7 @@ require 'action_mailer/utils'
0
 module ActionMailer
0
   # Represents a subpart of an email message. It shares many similar
0
   # attributes of ActionMailer::Base.  Although you can create parts manually
0
-  # and add them to the #parts list of the mailer, it is easier
0
+  # and add them to the +parts+ list of the mailer, it is easier
0
   # to use the helper methods in ActionMailer::PartContainer.
0
   class Part
0
     include ActionMailer::AdvAttrAccessor
0
@@ -13,7 +13,7 @@ module ActionMailer
0
 
0
     # Represents the body of the part, as a string. This should not be a
0
     # Hash (like ActionMailer::Base), but if you want a template to be rendered
0
-    # into the body of a subpart you can do it with the mailer's #render method
0
+    # into the body of a subpart you can do it with the mailer's +render+ method
0
     # and assign the result here.
0
     adv_attr_accessor :body
0
     

0
@@ -1,7 +1,8 @@
0
 module ActionController
0
   module Assertions
0
     module ModelAssertions
0
-      # Ensures that the passed record is valid by ActiveRecord standards and returns any error messages if it is not.
0
+      # Ensures that the passed record is valid by Active Record standards and
0
+      # returns any error messages if it is not.
0
       #
0
       # ==== Examples
0
       #

0
@@ -59,7 +59,7 @@ module ActionController
0
         end
0
       end
0
 
0
-      # Asserts that the provided options can be used to generate the provided path.  This is the inverse of #assert_recognizes.
0
+      # Asserts that the provided options can be used to generate the provided path.  This is the inverse of +assert_recognizes+.
0
       # The +extras+ parameter is used to tell the request the names and values of additional request parameters that would be in
0
       # a query string. The +message+ parameter allows you to specify a custom error message for assertion failures.
0
       #
0
@@ -96,8 +96,8 @@ module ActionController
0
       end
0
 
0
       # Asserts that path and options match both ways; in other words, it verifies that <tt>path</tt> generates 
0
-      # <tt>options</tt> and then that <tt>options</tt> generates <tt>path</tt>.  This essentially combines #assert_recognizes 
0
-      # and #assert_generates into one step.
0
+      # <tt>options</tt> and then that <tt>options</tt> generates <tt>path</tt>.  This essentially combines +assert_recognizes+
0
+      # and +assert_generates+ into one step.
0
       #
0
       # The +extras+ hash allows you to specify options that would normally be provided as a query string to the action.  The
0
       # +message+ parameter allows you to specify a custom error message to display upon failure.  

0
@@ -12,12 +12,12 @@ module ActionController
0
       NO_STRIP = %w{pre script style textarea}
0
     end
0
 
0
-    # Adds the #assert_select method for use in Rails functional
0
+    # Adds the +assert_select+ method for use in Rails functional
0
     # test cases, which can be used to make assertions on the response HTML of a controller
0
-    # action. You can also call #assert_select within another #assert_select to
0
+    # action. You can also call +assert_select+ within another +assert_select+ to
0
     # make assertions on elements selected by the enclosing assertion.
0
     #
0
-    # Use #css_select to select elements without making an assertions, either
0
+    # Use +css_select+ to select elements without making an assertions, either
0
     # from the response HTML or elements selected by the enclosing assertion.
0
     # 
0
     # In addition to HTML responses, you can make the following assertions:
0
@@ -44,8 +44,8 @@ module ActionController
0
       # base element and any of its children. Returns an empty array if no
0
       # match is found.
0
       #
0
-      # The selector may be a CSS selector expression (+String+), an expression
0
-      # with substitution values (+Array+) or an HTML::Selector object.
0
+      # The selector may be a CSS selector expression (String), an expression
0
+      # with substitution values (Array) or an HTML::Selector object.
0
       #
0
       # ==== Examples
0
       #   # Selects all div tags
0
@@ -114,8 +114,8 @@ module ActionController
0
       # starting from (and including) that element and all its children in
0
       # depth-first order.
0
       #
0
-      # If no element if specified, calling #assert_select will select from the
0
-      # response HTML. Calling #assert_select inside an #assert_select block will
0
+      # If no element if specified, calling +assert_select+ will select from the
0
+      # response HTML. Calling #assert_select inside an +assert_select+ block will
0
       # run the assertion for each element selected by the enclosing assertion.
0
       #
0
       # ==== Example
0
@@ -130,7 +130,7 @@ module ActionController
0
       #     assert_select "li"
0
       #   end
0
       #
0
-      # The selector may be a CSS selector expression (+String+), an expression
0
+      # The selector may be a CSS selector expression (String), an expression
0
       # with substitution values, or an HTML::Selector object.
0
       #
0
       # === Equality Tests
0
@@ -356,16 +356,16 @@ module ActionController
0
       #
0
       # === Using blocks
0
       #
0
-      # Without a block, #assert_select_rjs merely asserts that the response
0
+      # Without a block, +assert_select_rjs+ merely asserts that the response
0
       # contains one or more RJS statements that replace or update content.
0
       #
0
-      # With a block, #assert_select_rjs also selects all elements used in
0
+      # With a block, +assert_select_rjs+ also selects all elements used in
0
       # these statements and passes them to the block. Nested assertions are
0
       # supported.
0
       #
0
-      # Calling #assert_select_rjs with no arguments and using nested asserts
0
+      # Calling +assert_select_rjs+ with no arguments and using nested asserts
0
       # asserts that the HTML content is returned by one or more RJS statements.
0
-      # Using #assert_select directly makes the same assertion on the content,
0
+      # Using +assert_select+ directly makes the same assertion on the content,
0
       # but without distinguishing whether the content is returned in an HTML
0
       # or JavaScript.
0
       #
0
@@ -601,7 +601,7 @@ module ActionController
0
           RJS_PATTERN_UNICODE_ESCAPED_CHAR = /\\u([0-9a-zA-Z]{4})/
0
         end
0
 
0
-        # #assert_select and #css_select call this to obtain the content in the HTML
0
+        # +assert_select+ and +css_select+ call this to obtain the content in the HTML
0
         # page, or from all the RJS statements, depending on the type of response.
0
         def response_from_page_or_rjs()
0
           content_type = @response.content_type

0
@@ -91,7 +91,7 @@ module ActionController
0
       #              :descendant => { :tag => "span",
0
       #                               :child => /hello world/ }
0
       #
0
-      # <b>Please note</b>: #assert_tag and #assert_no_tag only work
0
+      # <b>Please note</b>: +assert_tag+ and +assert_no_tag+ only work
0
       # with well-formed XHTML. They recognize a few tags as implicitly self-closing
0
       # (like br and hr and such) but will not work correctly with tags
0
       # that allow optional closing tags (p, li, td). <em>You must explicitly
0
@@ -104,8 +104,8 @@ module ActionController
0
         end
0
       end
0
       
0
-      # Identical to #assert_tag, but asserts that a matching tag does _not_
0
-      # exist. (See #assert_tag for a full discussion of the syntax.)
0
+      # Identical to +assert_tag+, but asserts that a matching tag does _not_
0
+      # exist. (See +assert_tag+ for a full discussion of the syntax.)
0
       #
0
       # === Examples
0
       #   # Assert that there is not a "div" containing a "p"

0
@@ -104,7 +104,7 @@ module ActionController #:nodoc:
0
   #   end
0
   #
0
   # Actions, by default, render a template in the <tt>app/views</tt> directory corresponding to the name of the controller and action
0
-  # after executing code in the action. For example, the +index+ action of the +GuestBookController+  would render the
0
+  # after executing code in the action. For example, the +index+ action of the GuestBookController would render the
0
   # template <tt>app/views/guestbook/index.erb</tt> by default after populating the <tt>@entries</tt> instance variable.
0
   #
0
   # Unlike index, the sign action will not render a template. After performing its main purpose (creating a
0
@@ -118,10 +118,10 @@ module ActionController #:nodoc:
0
   #
0
   # Requests are processed by the Action Controller framework by extracting the value of the "action" key in the request parameters.
0
   # This value should hold the name of the action to be performed. Once the action has been identified, the remaining
0
-  # request parameters, the session (if one is available), and the full request with all the http headers are made available to
0
+  # request parameters, the session (if one is available), and the full request with all the HTTP headers are made available to
0
   # the action through instance variables. Then the action is performed.
0
   #
0
-  # The full request object is available with the request accessor and is primarily used to query for http headers. These queries
0
+  # The full request object is available with the request accessor and is primarily used to query for HTTP headers. These queries
0
   # are made by accessing the environment hash, like this:
0
   #
0
   #   def server_ip
0
@@ -291,10 +291,10 @@ module ActionController #:nodoc:
0
     cattr_accessor :allow_concurrency
0
 
0
     # Modern REST web services often need to submit complex data to the web application.
0
-    # The param_parsers hash lets you register handlers which will process the http body and add parameters to the
0
-    # <tt>params</tt> hash. These handlers are invoked for post and put requests.
0
+    # The <tt>@@param_parsers</tt> hash lets you register handlers which will process the HTTP body and add parameters to the
0
+    # <tt>params</tt> hash. These handlers are invoked for POST and PUT requests.
0
     #
0
-    # By default application/xml is enabled. A XmlSimple class with the same param name as the root will be instantiated
0
+    # By default <tt>application/xml</tt> is enabled. A XmlSimple class with the same param name as the root will be instantiated
0
     # in the <tt>params</tt>. This allows XML requests to mask themselves as regular form submissions, so you can have one
0
     # action serve both regular forms and web service requests.
0
     #
0
@@ -307,7 +307,7 @@ module ActionController #:nodoc:
0
     #
0
     # Note: Up until release 1.1 of Rails, Action Controller would default to using XmlSimple configured to discard the
0
     # root node for such requests. The new default is to keep the root, such that "<r><name>David</name></r>" results
0
-    # in params[:r][:name] for "David" instead of params[:name]. To get the old behavior, you can
0
+    # in <tt>params[:r][:name]</tt> for "David" instead of <tt>params[:name]</tt>. To get the old behavior, you can
0
     # re-register XmlSimple as application/xml handler ike this:
0
     #
0
     #   ActionController::Base.param_parsers[Mime::XML] =

0
@@ -6,25 +6,24 @@ class CGI #:nodoc:
0
     attr_accessor :name, :value, :path, :domain, :expires
0
     attr_reader :secure, :http_only
0
 
0
-    # Create a new CGI::Cookie object.
0
+    # Creates a new CGI::Cookie object.
0
     #
0
     # The contents of the cookie can be specified as a +name+ and one
0
     # or more +value+ arguments.  Alternatively, the contents can
0
     # be specified as a single hash argument.  The possible keywords of
0
     # this hash are as follows:
0
     #
0
-    # name:: the name of the cookie.  Required.
0
-    # value:: the cookie's value or list of values.
0
-    # path:: the path for which this cookie applies.  Defaults to the
0
-    #        base directory of the CGI script.
0
-    # domain:: the domain for which this cookie applies.
0
-    # expires:: the time at which this cookie expires, as a +Time+ object.
0
-    # secure:: whether this cookie is a secure cookie or not (default to
0
-    #          false).  Secure cookies are only transmitted to HTTPS
0
-    #          servers.
0
-    # http_only:: whether this cookie can be accessed by client side scripts (e.g. document.cookie) or only over HTTP 
0
-    #             More details: http://msdn2.microsoft.com/en-us/library/system.web.httpcookie.httponly.aspx
0
-    #             Defaults to false.
0
+    # * <tt>:name</tt> - The name of the cookie.  Required.
0
+    # * <tt>:value</tt> - The cookie's value or list of values.
0
+    # * <tt>:path</tt> - The path for which this cookie applies.  Defaults to the
0
+    #   base directory of the CGI script.
0
+    # * <tt>:domain</tt> - The domain for which this cookie applies.
0
+    # * <tt>:expires</tt> - The time at which this cookie expires, as a Time object.
0
+    # * <tt>:secure</tt> - Whether this cookie is a secure cookie or not (defaults to
0
+    #   +false+). Secure cookies are only transmitted to HTTPS servers.
0
+    # * <tt>:http_only</tt> - Whether this cookie can be accessed by client side scripts (e.g. document.cookie) or only over HTTP.
0
+    #   More details in http://msdn2.microsoft.com/en-us/library/system.web.httpcookie.httponly.aspx. Defaults to +false+. 
0
+    #
0
     # These keywords correspond to attributes of the cookie object.
0
     def initialize(name = '', *value)
0
       if name.kind_of?(String)
0
@@ -56,17 +55,17 @@ class CGI #:nodoc:
0
       super(@value)
0
     end
0
 
0
-    # Set whether the Cookie is a secure cookie or not.
0
+    # Sets whether the Cookie is a secure cookie or not.
0
     def secure=(val)
0
       @secure = val == true
0
     end
0
 
0
-    # Set whether the Cookie is an HTTP only cookie or not.
0
+    # Sets whether the Cookie is an HTTP only cookie or not.
0
     def http_only=(val)
0
       @http_only = val == true
0
     end
0
 
0
-    # Convert the Cookie to its string representation.
0
+    # Converts the Cookie to its string representation.
0
     def to_s
0
       buf = ''
0
       buf << @name << '='
0
@@ -79,11 +78,11 @@ class CGI #:nodoc:
0
       buf
0
     end
0
 
0
-    # Parse a raw cookie string into a hash of cookie-name=>Cookie
0
+    # Parses a raw cookie string into a hash of <tt>cookie-name => cookie-object</tt>
0
     # pairs.
0
     #
0
     #   cookies = CGI::Cookie::parse("raw_cookie_string")
0
-    #     # { "name1" => cookie1, "name2" => cookie2, ... }
0
+    #     # => { "name1" => cookie1, "name2" => cookie2, ... }
0
     #
0
     def self.parse(raw_cookie)
0
       cookies = Hash.new([])

0
@@ -15,7 +15,7 @@ module ActionController #:nodoc:
0
     # * <tt>:new_session</tt> - if true, force creation of a new session.  If not set, a new session is only created if none currently
0
     #   exists.  If false, a new session is never created, and if none currently exists and the +session_id+ option is not set,
0
     #   an ArgumentError is raised.
0
-    # * <tt>:session_expires</tt> - the time the current session expires, as a +Time+ object.  If not set, the session will continue
0
+    # * <tt>:session_expires</tt> - the time the current session expires, as a Time object.  If not set, the session will continue
0
     #   indefinitely.
0
     # * <tt>:session_domain</tt> - the hostname domain for which this session is valid. If not set, defaults to the hostname of the
0
     #   server.

0
@@ -100,10 +100,10 @@ module ActionController #:nodoc:
0
     #
0
     # Around filters wrap an action, executing code both before and after.
0
     # They may be declared as method references, blocks, or objects responding
0
-    # to #filter or to both #before and #after.
0
+    # to +filter+ or to both +before+ and +after+.
0
     #
0
-    # To use a method as an around_filter, pass a symbol naming the Ruby method.
0
-    # Yield (or block.call) within the method to run the action.
0
+    # To use a method as an +around_filter+, pass a symbol naming the Ruby method.
0
+    # Yield (or <tt>block.call</tt>) within the method to run the action.
0
     #
0
     #   around_filter :catch_exceptions
0
     #
0
@@ -115,9 +115,9 @@ module ActionController #:nodoc:
0
     #       raise
0
     #     end
0
     #
0
-    # To use a block as an around_filter, pass a block taking as args both
0
+    # To use a block as an +around_filter+, pass a block taking as args both
0
     # the controller and the action block. You can't call yield directly from
0
-    # an around_filter block; explicitly call the action block instead:
0
+    # an +around_filter+ block; explicitly call the action block instead:
0
     #
0
     #   around_filter do |controller, action|
0
     #     logger.debug "before #{controller.action_name}"
0
@@ -125,7 +125,7 @@ module ActionController #:nodoc:
0
     #     logger.debug "after #{controller.action_name}"
0
     #   end
0
     #
0
-    # To use a filter object with around_filter, pass an object responding
0
+    # To use a filter object with +around_filter+, pass an object responding
0
     # to <tt>:filter</tt> or both <tt>:before</tt> and <tt>:after</tt>. With a
0
     # filter method, yield to the block as above:
0
     #
0
@@ -137,7 +137,7 @@ module ActionController #:nodoc:
0
     #     end
0
     #   end
0
     #
0
-    # With before and after methods:
0
+    # With +before+ and +after+ methods:
0
     #
0
     #   around_filter Authorizer.new
0
     #
0
@@ -154,9 +154,9 @@ module ActionController #:nodoc:
0
     #     end
0
     #   end
0
     #
0
-    # If the filter has before and after methods, the before method will be
0
-    # called before the action. If before renders or redirects, the filter chain is
0
-    # halted and after will not be run. See Filter Chain Halting below for
0
+    # If the filter has +before+ and +after+ methods, the +before+ method will be
0
+    # called before the action. If +before+ renders or redirects, the filter chain is
0
+    # halted and +after+ will not be run. See Filter Chain Halting below for
0
     # an example.
0
     #
0
     # == Filter chain skipping
0
@@ -215,7 +215,7 @@ module ActionController #:nodoc:
0
     #
0
     # <tt>before_filter</tt> and <tt>around_filter</tt> may halt the request
0
     # before a controller action is run. This is useful, for example, to deny
0
-    # access to unauthenticated users or to redirect from http to https.
0
+    # access to unauthenticated users or to redirect from HTTP to HTTPS.
0
     # Simply call render or redirect. After filters will not be executed if the filter 
0
     # chain is halted.
0
     #
0
@@ -241,10 +241,10 @@ module ActionController #:nodoc:
0
     #   . /
0
     #   #after (actual filter code is run, unless the around filter does not yield)
0
     #
0
-    # If #around returns before yielding, #after will still not be run. The #before
0
-    # filter and controller action will not be run. If #before renders or redirects,
0
-    # the second half of #around and will still run but #after and the
0
-    # action will not. If #around fails to yield, #after will not be run.
0
+    # If +around+ returns before yielding, +after+ will still not be run. The +before+
0
+    # filter and controller action will not be run. If +before+ renders or redirects,
0
+    # the second half of +around+ and will still run but +after+ and the
0
+    # action will not. If +around+ fails to yield, +after+ will not be run.
0
 
0
     class FilterChain < ActiveSupport::Callbacks::CallbackChain #:nodoc:
0
       def append_filter_to_chain(filters, filter_type, &block)
0
@@ -471,7 +471,7 @@ module ActionController #:nodoc:
0
       # Shorthand for append_after_filter since it's the most common.
0
       alias :after_filter :append_after_filter
0
 
0
-      # If you append_around_filter A.new, B.new, the filter chain looks like
0
+      # If you <tt>append_around_filter A.new, B.new</tt>, the filter chain looks like
0
       #
0