From 98dc582742779081e71e697fcdf8d9ae2b421b16 Mon Sep 17 00:00:00 2001
From: Pratik Naik <pratiknaik@gmail.com>
Date: Sun, 25 May 2008 12:29:00 +0100
Subject: Merge docrails.

Signed-off-by: Pratik Naik <pratiknaik@gmail.com>
---
 actionpack/lib/action_controller/cgi_ext/cookie.rb | 35 +++++++++++-----------
 1 file changed, 17 insertions(+), 18 deletions(-)

(limited to 'actionpack/lib/action_controller/cgi_ext')

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