X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FResponse.pm;h=8aa9b22fd43d4edeba07d289487702cb14f8466c;hb=b7ce908fc5c404dcbc480c7ecf9a275b92fcc26f;hp=a6fbf0f1a750653f0ad113148fe568413cbae061;hpb=ac965e92078c3aee85d0d5db153c728cd26cf182;p=catagits%2FCatalyst-Runtime.git

diff --git a/lib/Catalyst/Response.pm b/lib/Catalyst/Response.pm
index a6fbf0f..8aa9b22 100644
--- a/lib/Catalyst/Response.pm
+++ b/lib/Catalyst/Response.pm
@@ -14,7 +14,7 @@ sub header           { shift->headers->header(@_) }
 
 =head1 NAME
 
-Catalyst::Response - Catalyst Response Class
+Catalyst::Response - stores output responding to the current client request
 
 =head1 SYNOPSIS
 
@@ -31,81 +31,74 @@ Catalyst::Response - Catalyst Response Class
     $res->status;
     $res->write;
 
-See also L<Catalyst::Application>.
-
 =head1 DESCRIPTION
 
-This is the Catalyst Response class, which provides a set of accessors
-to response data.
+This is the Catalyst Response class, which provides methods for responding to
+the current client request.
 
 =head1 METHODS
 
-=over 4
-
-=item $res->body($text)
+=head2 $res->body($text)
 
     $c->response->body('Catalyst rocks!');
 
-Contains the final output.
-
-=item $res->content_encoding
+Sets or returns the output (text or binary data).
 
-Shortcut to $res->headers->content_encoding
+=head2 $res->content_encoding
 
-=item $res->content_length
+Shortcut for $res->headers->content_encoding.
 
-Shortcut to $res->headers->content_length
+=head2 $res->content_length
 
-=item $res->content_type
+Shortcut for $res->headers->content_length.
 
-Shortcut to $res->headers->content_type
+=head2 $res->content_type
 
-=item $res->cookies
+Shortcut for $res->headers->content_type.
 
-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' };
+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>.
 
-The values correspond to the L<CGI::Cookie> parameters of the same name, except
-they are used without a leading dash.
+=head2 $res->cookies
 
-The proxied parameters are
+Returns a reference to a hash containing cookies to be set. The keys of the
+hash are the cookies' names, and their corresponding values are hash
+references used to construct a L<CGI::Cookie> object.
 
-=over 4
-
-=item value
+    $c->response->cookies->{foo} = { value => '123' };
 
-=item expires
+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:
 
-=item domain
+=head2 value
 
-=item path
+=head2 expires
 
-=item secure
+=head2 domain
 
-=item 
+=head2 path
 
-=back
+=head2 secure
 
-=item $res->header
+=head2 $res->header
 
-Shortcut to $res->headers->header
+Shortcut for $res->headers->header.
 
-=item $res->headers
+=head2 $res->headers
 
-Returns a L<HTTP::Headers> object containing the headers.
+Returns an L<HTTP::Headers> object, which can be used to set headers.
 
     $c->response->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
 
-=item $res->output
+=head2 $res->output
 
-Shortcut to $res->body
+Alias for $res->body.
 
-=item $res->redirect( $url, $status )
+=head2 $res->redirect( $url, $status )
 
-Contains a location to redirect to.
+Causes the response to redirect to the specified URL.
 
     $c->response->redirect( 'http://slashdot.org' );
     $c->response->redirect( 'http://slashdot.org', 307 );
@@ -126,13 +119,13 @@ sub redirect {
     return $self->location;
 }
 
-=item $res->status
+=head2 $res->status
 
-Contains the HTTP status.
+Sets or returns the HTTP status.
 
     $c->response->status(404);
     
-=item $res->write( $data )
+=head2 $res->write( $data )
 
 Writes $data to the output stream.
 
@@ -140,11 +133,10 @@ Writes $data to the output stream.
 
 sub write { shift->{_context}->write(@_); }
 
-=back
-
-=head1 AUTHOR
+=head1 AUTHORS
 
 Sebastian Riedel, C<sri@cpan.org>
+
 Marcus Ramberg, C<mramberg@cpan.org>
 
 =head1 COPYRIGHT