added docs for engine/dispatcher

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

diff --git a/lib/Catalyst/DispatchType.pm b/lib/Catalyst/DispatchType.pm
index 98ac0eb..196d3fd 100644 (file)
--- a/lib/Catalyst/DispatchType.pm
+++ b/lib/Catalyst/DispatchType.pm
@@ -17,18 +17,29 @@ See L<Catalyst>.
 
 =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 )
 
+abstract method, to be implemented by dispatchtypes. Returns true if the
+dispatch type matches the given path
+
 =cut
 
 sub match { die "Abstract method!" }
 
 =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 { }