From: Yuval Kogman <nothingmuch@woobling.org>
Date: Thu, 3 Nov 2005 15:43:43 +0000 (+0000)
Subject: Document the format of the parameters to be passed into Catalyst::Response::cookies
X-Git-Tag: 5.7099_04~1038
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=commitdiff_plain;h=ac965e92078c3aee85d0d5db153c728cd26cf182

Document the format of the parameters to be passed into Catalyst::Response::cookies
---

diff --git a/lib/Catalyst/Response.pm b/lib/Catalyst/Response.pm
index 18930da..a6fbf0f 100644
--- a/lib/Catalyst/Response.pm
+++ b/lib/Catalyst/Response.pm
@@ -62,10 +62,33 @@ Shortcut to $res->headers->content_type
 
 =item $res->cookies
 
-Returns a reference to a hash containing the cookies to be set.
+Returns a reference to a hash containing the cookies to be set. The keys of the
+hash are the cookies' names, and their corresponding values are hash references
+used to construct L<CGI::Cookie> object.
 
     $c->response->cookies->{foo} = { value => '123' };
 
+The values correspond to the L<CGI::Cookie> parameters of the same name, except
+they are used without a leading dash.
+
+The proxied parameters are
+
+=over 4
+
+=item value
+
+=item expires
+
+=item domain
+
+=item path
+
+=item secure
+
+=item 
+
+=back
+
 =item $res->header
 
 Shortcut to $res->headers->header