aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack/lib/action_controller/cookies.rb
diff options
context:
space:
mode:
authorDavid Heinemeier Hansson <david@loudthinking.com>2004-12-16 17:45:37 +0000
committerDavid Heinemeier Hansson <david@loudthinking.com>2004-12-16 17:45:37 +0000
commit0b554201bb2deb6bbb23de9b00aebd53b134921b (patch)
tree5fd8b334d49b7df5c4ae9d83ea7dd118d44678a1 /actionpack/lib/action_controller/cookies.rb
parentf389a8fb5d15d2433cea93b2833dce751dec8edc (diff)
downloadrails-0b554201bb2deb6bbb23de9b00aebd53b134921b.tar.gz
rails-0b554201bb2deb6bbb23de9b00aebd53b134921b.tar.bz2
rails-0b554201bb2deb6bbb23de9b00aebd53b134921b.zip
Updated documentation
git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@194 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
Diffstat (limited to 'actionpack/lib/action_controller/cookies.rb')
-rw-r--r--actionpack/lib/action_controller/cookies.rb16
1 files changed, 10 insertions, 6 deletions
diff --git a/actionpack/lib/action_controller/cookies.rb b/actionpack/lib/action_controller/cookies.rb
index 6b9954f84d..76ca12e913 100644
--- a/actionpack/lib/action_controller/cookies.rb
+++ b/actionpack/lib/action_controller/cookies.rb
@@ -10,15 +10,19 @@ module ActionController #:nodoc:
#
# cookies["user_name"] # => "david"
# cookies.size # => 2
+ #
+ # Example for deleting:
+ #
+ # cookies.delete "user_name"
#
# All the option symbols for setting cookies are:
#
- # value:: the cookie's value or list of values (as an array).
- # path:: the path for which this cookie applies. Defaults to the root of the application.
- # 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.
+ # * <tt>value</tt> - the cookie's value or list of values (as an array).
+ # * <tt>path</tt> - the path for which this cookie applies. Defaults to the root of the application.
+ # * <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 (default to false).
+ # Secure cookies are only transmitted to HTTPS servers.
module Cookies
# Returns the cookie container, which operates as described above.
def cookies