Fix POD coverage with some crappy documentation

[catagits/Catalyst-Engine-STOMP.git] / lib / Catalyst / Controller / MessageDriven.pm

diff --git a/lib/Catalyst/Controller/MessageDriven.pm b/lib/Catalyst/Controller/MessageDriven.pm
index 0c00a8d..7568cd2 100644 (file)
--- a/lib/Catalyst/Controller/MessageDriven.pm
+++ b/lib/Catalyst/Controller/MessageDriven.pm
@@ -13,7 +13,7 @@ Catalyst::Controller::MessageDriven
   use Moose;
   BEGIN { extends 'Catalyst::Controller::MessageDriven' }
 
-  sub some_action : Local { 
+  sub some_action : Local {
       my ($self, $c) = @_;
       # Reply with a minimal response message
       my $response = { type => 'testaction_response' };
@@ -24,42 +24,63 @@ Catalyst::Controller::MessageDriven
 
 A Catalyst controller base class for use with Catalyst::Engine::Stomp,
 which handles YAML-serialized messages. A top-level "type" key in the
-YAML determines the action dispatched to. 
+YAML determines the action dispatched to.
 
 =cut
 
 __PACKAGE__->config(
-                   'default'   => 'text/x-yaml',
-                   'stash_key' => 'response',
-                   'map'       => { 'text/x-yaml' => 'YAML' },
-                  );
+            'default'   => 'text/x-yaml',
+            'stash_key' => 'response',
+            'map'       => { 'text/x-yaml' => 'YAML' },
+           );
 
 sub begin :ActionClass('Deserialize') { }
 
 sub end :ActionClass('Serialize') {
-       my ($self, $c) = @_;
-
-       # Engine will send our reply based on the value of this header.
-       $c->response->headers->header( 'X-Reply-Address' => $c->req->data->{reply_to} );
-
-       # Custom error handler - steal errors from catalyst and dump them into
-       # the stash, to get them serialized out as the reply.
-       if (scalar @{$c->error}) {
-               my $error = join "\n", @{$c->error};
-               $c->stash->{response} = { status => 'ERROR', error => $error };
-               $c->error(0); # clear errors, so our response isn't clobbered
-       }
+    my ($self, $c) = @_;
+
+    # Engine will send our reply based on the value of this header.
+    $c->response->headers->header( 'X-Reply-Address' => $c->req->data->{reply_to} );
+
+    # Custom error handler - steal errors from catalyst and dump them into
+    # the stash, to get them serialized out as the reply.
+     if (scalar @{$c->error}) {
+         my $error = join "\n", @{$c->error};
+         $c->stash->{response} = { status => 'ERROR', error => $error };
+         $c->error(0); # clear errors, so our response isn't clobbered
+     }
 }
 
 sub default : Private {
-       my ($self, $c) = @_;
-       
-       # Forward the request to the appropriate action, based on the
-       # message type.
-       my $action = $c->req->data->{type};
-       $c->forward($action, [$c->req->data]);
+    my ($self, $c) = @_;
+
+    # Forward the request to the appropriate action, based on the
+    # message type.
+    my $action = $c->req->data->{type};
+    $c->forward($action, [$c->req->data]);
 }
 
 __PACKAGE__->meta->make_immutable;
 
-1;
+=head1 METHODS
+
+=head2 default
+
+Forwards the request to the appropriate action based on the 'type' field
+within the message data.
+
+=head2 begin
+
+Uses L<Catalyst::Action::Deserialize> to unserialize the message.
+
+=head2 end
+
+Serializes the data stashed by the dispatched action, and
+arranges for the reply to be sent to the endpoint nominated in
+the request's 'reply_to' field.
+
+Supplies custom exception handling which returns
+throw exceptions as a serialized return message.
+
+=cut
+