X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FDispatchType.pm;h=a3f271efefe3e8019525e1428ad2e8213a6422de;hp=dc12b5710d033dbbd27420c2723e633be48ed721;hb=0bf7ab7160f4f2fd0f00cd3d53ac311e9ad50241;hpb=a9cbd748a5bef5badba4a3f012e5df75cccd60ca

diff --git a/lib/Catalyst/DispatchType.pm b/lib/Catalyst/DispatchType.pm
index dc12b57..a3f271e 100644
--- a/lib/Catalyst/DispatchType.pm
+++ b/lib/Catalyst/DispatchType.pm
@@ -13,34 +13,54 @@ See L<Catalyst>.
 
 =head1 DESCRIPTION
 
+This is an abstract base class for Dispatch Types. 
+
 =head1 METHODS
 
-=over 4
+=head2 $self->list($c)
 
-=item $self->list($c)
+abstract method, to be implemented by dispatchtypes. Called to display
+info in debug log.
 
 =cut
 
 sub list { }
 
-=item $self->match( $c, $path )
+=head2 $self->match( $c, $path )
+
+abstract method, to be implemented by dispatchtypes. Returns true if the
+dispatch type matches the given path
 
 =cut
 
 sub match { die "Abstract method!" }
 
-=item $self->register( $c, $action )
+=head2 $self->register( $c, $action )
+
+abstract method, to be implemented by dispatchtypes. Takes a
+context object and a L<Catalyst::Action> object. 
+
+Should return true if it registers something, or false otherwise.
 
 =cut
 
 sub register { }
 
-=back
+=head2 $self->uri_for_action( $action, \@captures )
+
+abstract method, to be implemented by dispatchtypes. Takes a
+L<Catalyst::Action> object and an arrayref of captures, and should
+return either a URI part which if placed in $c->req->path would cause
+$self->match to match this action and set $c->req->captures to the supplied
+arrayref, or undef if unable to do so.
+
+=cut
+
+sub uri_for_action { }
 
-=head1 AUTHOR
+=head1 AUTHORS
 
-Matt S Trout
-Sebastian Riedel, C<sri@cpan.org>
+Catalyst Contributors, see Catalyst.pm
 
 =head1 COPYRIGHT