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

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

diff --git a/lib/Catalyst/Action.pm b/lib/Catalyst/Action.pm
index 0ddd796..a4f5eb4 100644 (file)
--- a/lib/Catalyst/Action.pm
+++ b/lib/Catalyst/Action.pm
@@ -3,6 +3,24 @@ package Catalyst::Action;
 use strict;
 use base qw/Class::Accessor::Fast/;
 
+
+=head1 NAME
+
+Catalyst::Action - Catalyst Action
+
+=head1 SYNOPSIS
+
+       <form action="[%c.uri_for(c.action.reverse)%]">
+       
+=head1 DESCRIPTION
+
+This class represents a Catalyst Action. You can access the object for the 
+currently dispatched action via $c->action. See the L<Catalyst::Dispatcher>
+for more information on how actions are dispatched. Actions are defined in
+L<Catalyst::Controller> subclasses.
+
+=cut
+
 __PACKAGE__->mk_accessors(qw/class namespace reverse attributes name code/);
 
 use overload (
@@ -18,71 +36,57 @@ use overload (
 
 );
 
-=head1 NAME
-
-Catalyst::Action - Catalyst Action
+sub dispatch {    # Execute ourselves against a context
+    my ( $self, $c ) = @_;
+    local $c->namespace = $self->namespace;
+    return $c->execute( $self->class, $self );
+}
 
-=head1 SYNOPSIS
+sub execute {
+  my $self = shift;
+  $self->{code}->(@_);
+}
 
-See L<Catalyst>.
+sub match {
+    my ( $self, $c ) = @_;
+    return 1 unless exists $self->attributes->{Args};
+    my $args = $self->attributes->{Args}[0];
+    return 1 unless defined($args) && length($args);
+    return scalar( @{ $c->req->args } ) == $args;
+}
 
-=head1 DESCRIPTION
+1;
 
-This class represents a Catalyst Action. You can access the object for the 
-currently dispatched action via $c->action
+__END__
 
 =head1 METHODS
 
 =head2 attributes
 
 The sub attributes that are set for this action, like Local, Path, Private
-and so on.
+and so on. This determines how the action is dispatched to.
 
 =head2 class
 
-Returns the class name of this action
+Returns the class name where this action is defined.
 
 =head2 code
 
-Returns a code reference to this action
+Returns a code reference to this action.
 
 =head2 dispatch( $c )
 
 Dispatch this action against a context
 
-=cut
-
-sub dispatch {    # Execute ourselves against a context
-    my ( $self, $c ) = @_;
-    local $c->namespace = $self->namespace;
-    return $c->execute( $self->class, $self );
-}
-
 =head2 execute( $controller, $c, @args )
 
 Execute this action's coderef against a given controller with a given
 context and arguments
 
-=cut
-
-sub execute {
-  my $self = shift;
-  $self->{code}->(@_);
-}
-
 =head2 match( $c )
 
 Check Args attribute, and makes sure number of args matches the setting.
-
-=cut
-
-sub match {
-    my ( $self, $c ) = @_;
-    return 1 unless exists $self->attributes->{Args};
-    my $args = $self->attributes->{Args}[0];
-    return 1 unless defined($args) && length($args);
-    return scalar( @{ $c->req->args } ) == $args;
-}
+Always returns true if Args is omitted.
 
 =head2 namespace
 
@@ -105,6 +109,4 @@ Matt S. Trout
 This program is free software, you can redistribute it and/or modify it under
 the same terms as Perl itself.
 
-=cut
-
-1;
+=cut
\ No newline at end of file