refactored to leave synopsis to the top, and move the rest of the pod to the

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

diff --git a/lib/Catalyst/ActionChain.pm b/lib/Catalyst/ActionChain.pm
index 6d16104..2fd63d9 100644 (file)
--- a/lib/Catalyst/ActionChain.pm
+++ b/lib/Catalyst/ActionChain.pm
@@ -3,20 +3,6 @@ package Catalyst::ActionChain;
 use strict;
 use base qw/Catalyst::Action/;
 
-__PACKAGE__->mk_accessors(qw/chain/);
-
-use overload (
-
-    # Stringify to reverse for debug output etc.
-    q{""} => sub { shift->{reverse} },
-
-    # Codulate to execute to invoke the encapsulated action coderef
-    '&{}' => sub { my $self = shift; sub { $self->execute(@_); }; },
-
-    # Make general $stuff still work
-    fallback => 1,
-
-);
 
 =head1 NAME
 
@@ -24,7 +10,7 @@ Catalyst::ActionChain - Chain of Catalyst Actions
 
 =head1 SYNOPSIS
 
-See L<Catalyst>.
+See L<Catalyst::Manual::Intro> for more info about Chained actions.
 
 =head1 DESCRIPTION
 
@@ -32,19 +18,23 @@ This class represents a chain of Catalyst Actions. It behaves exactly like
 the action at the *end* of the chain except on dispatch it will execute all
 the actions in the chain in order.
 
-=head1 METHODS
+=cut
 
-=head2 chain
+__PACKAGE__->mk_accessors(qw/chain/);
 
-Accessor for the action chain; will be an arrayref of the Catalyst::Action
-objects encapsulated by this chain.
+use overload (
 
-=head2 dispatch( $c )
+    # Stringify to reverse for debug output etc.
+    q{""} => sub { shift->{reverse} },
 
-Dispatch this action chain against a context; will dispatch the encapsulated
-actions in order.
+    # Codulate to execute to invoke the encapsulated action coderef
+    '&{}' => sub { my $self = shift; sub { $self->execute(@_); }; },
+
+    # Make general $stuff still work
+    fallback => 1,
+
+);
 
-=cut
 
 sub dispatch {
     my ( $self, $c ) = @_;
@@ -62,6 +52,28 @@ sub dispatch {
     $last->dispatch( $c );
 }
 
+sub from_chain {
+    my ( $self, $actions ) = @_;
+    my $final = $actions->[-1];
+    return $self->new({ %$final, chain => $actions });
+}
+
+1;
+
+__END__
+
+=head1 METHODS
+
+=head2 chain
+
+Accessor for the action chain; will be an arrayref of the Catalyst::Action
+objects encapsulated by this chain.
+
+=head2 dispatch( $c )
+
+Dispatch this action chain against a context; will dispatch the encapsulated
+actions in order.
+
 =head2 from_chain( \@actions )
 
 Takes a list of Catalyst::Action objects and constructs and returns a
@@ -69,12 +81,6 @@ Catalyst::ActionChain object representing a chain of these actions
 
 =cut
 
-sub from_chain {
-    my ( $self, $actions ) = @_;
-    my $final = $actions->[-1];
-    return $self->new({ %$final, chain => $actions });
-}
-
 =head1 AUTHOR
 
 Matt S. Trout
@@ -85,5 +91,3 @@ This program is free software, you can redistribute it and/or modify it under
 the same terms as Perl itself.
 
 =cut
-
-1;