X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FDispatchType.pm;h=f8476eb617a5a03b12d300a1417e94e2fe05721d;hb=b01f0c69c9821968a297b36d64eed9193287455a;hp=f8df3911e15c8a885a721a7f0958118d21823c5b;hpb=2633d7dc3bb9c0cf7bf3e7cf936d6411fe3ba5aa;p=catagits%2FCatalyst-Runtime.git

diff --git a/lib/Catalyst/DispatchType.pm b/lib/Catalyst/DispatchType.pm
index f8df391..f8476eb 100644
--- a/lib/Catalyst/DispatchType.pm
+++ b/lib/Catalyst/DispatchType.pm
@@ -13,23 +13,50 @@ See L<Catalyst>.
 
 =head1 DESCRIPTION
 
+This is an abstract base class for Dispatch Types. 
+
 =head1 METHODS
 
-=over 4
+=head2 $self->list($c)
+
+abstract method, to be implemented by dispatchtypes. Called to display
+info in debug log.
+
+=cut
+
+sub list { }
+
+=head2 $self->match( $c, $path )
 
-=item $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 { return }
+sub register { }
+
+=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
 
-=back
+sub uri_for_action { }
 
 =head1 AUTHOR