minor doc changes

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

diff --git a/lib/Catalyst/Response.pm b/lib/Catalyst/Response.pm
index e29380d..d22dc3c 100644 (file)
--- a/lib/Catalyst/Response.pm
+++ b/lib/Catalyst/Response.pm
@@ -11,44 +11,56 @@ Catalyst::Response - Catalyst Response Class
 
 =head1 SYNOPSIS
 
-See L<Catalyst::Application>.
+    $resp = $c->response;
+    $resp->cookies;
+    $resp->headers;
+    $resp->output;
+    $resp->redirect;
+    $resp->status;
+
+See also L<Catalyst::Application>.
 
 =head1 DESCRIPTION
 
-The Catalyst Response.
+This is the Catalyst Response class, which provides a set of accessors to
+response data.
+
+=head1 METHODS
 
-=head2 METHODS
+=over 4
 
-=head3 cookies
+=item $resp->cookies
 
-Returns a hashref containing the cookies.
+Returns a reference to a hash containing the cookies.
 
     $c->response->cookies->{foo} = { value => '123' };
 
-=head3 headers
+=item $resp->headers
 
 Returns a L<HTTP::Headers> object containing the headers.
 
     $c->response->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
 
-=head3 output
+=item $resp->output($text)
 
 Contains the final output.
 
     $c->response->output('Catalyst rockz!');
 
-=head3 redirect
+=item $resp->redirect($url)
 
 Contains a location to redirect to.
 
     $c->response->redirect('http://slashdot.org');
 
-=head3 status
+=item status
 
 Contains the HTTP status.
 
     $c->response->status(404);
 
+=back
+
 =head1 AUTHOR
 
 Sebastian Riedel, C<sri@cpan.org>