Add a test and update docs on how to pass-through the Authorization header under...

[catagits/Catalyst-Runtime.git] / lib / Catalyst / Response.pm

diff --git a/lib/Catalyst/Response.pm b/lib/Catalyst/Response.pm
index ff46398..877f8c9 100644 (file)
--- a/lib/Catalyst/Response.pm
+++ b/lib/Catalyst/Response.pm
@@ -34,15 +34,19 @@ Catalyst::Response - stores output responding to the current client request
 =head1 DESCRIPTION
 
 This is the Catalyst Response class, which provides methods for responding to
-the current client request.
+the current client request. The appropriate L<Catalyst::Engine> for your environment
+will turn the Catalyst::Response into a HTTP Response and return it to the client.
 
 =head1 METHODS
 
-=head2 $res->body($text)
+=head2 $res->body(<$text|$fh|$iofh_object)
 
     $c->response->body('Catalyst rocks!');
 
-Sets or returns the output (text or binary data).
+Sets or returns the output (text or binary data). If you are returning a large body,
+you might want to use a L<IO::FileHandle> type of object (Something that implements the read method
+in the same fashion), or a filehandle GLOB. Catalyst
+will write it piece by piece into the response.
 
 =head2 $res->content_encoding
 
@@ -56,6 +60,10 @@ Shortcut for $res->headers->content_length.
 
 Shortcut for $res->headers->content_type.
 
+This value is typically set by your view or plugin. For example,
+L<Catalyst::Plugin::Static::Simple> will guess the mime type based on the file
+it found, while L<Catalyst::View::TT> defaults to C<text/html>.
+
 =head2 $res->cookies
 
 Returns a reference to a hash containing cookies to be set. The keys of the
@@ -68,15 +76,19 @@ The keys of the hash reference on the right correspond to the L<CGI::Cookie>
 parameters of the same name, except they are used without a leading dash.
 Possible parameters are:
 
-=head2 value
+=over 
+
+=item value
+
+=item expires
 
-=head2 expires
+=item domain
 
-=head2 domain
+=item path
 
-=head2 path
+=item secure
 
-=head2 secure
+=back
 
 =head2 $res->header