added docs for engine/dispatcher

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

diff --git a/lib/Catalyst/DispatchType/Regex.pm b/lib/Catalyst/DispatchType/Regex.pm
index 520e038..9470297 100644 (file)
--- a/lib/Catalyst/DispatchType/Regex.pm
+++ b/lib/Catalyst/DispatchType/Regex.pm
@@ -18,6 +18,8 @@ See L<Catalyst>.
 
 =head2 $self->list($c)
 
+Output a table of all regex actions, and their private equivalent.
+
 =cut
 
 sub list {
@@ -33,6 +35,9 @@ sub list {
 
 =head2 $self->match( $c, $path )
 
+Check path against compiled regexes, and set action to any matching
+action. Returns 1 on success and 0 on failure.
+
 =cut
 
 sub match {
@@ -59,6 +64,11 @@ sub match {
 
 =head2 $self->register( $c, $action )
 
+Registers one or more regex actions for an action object.\
+Also registers them as literal paths.
+
+Returns 1 on if any regexps were registered.
+
 =cut
 
 sub register {
@@ -77,6 +87,9 @@ sub register {
 
 =head2 $self->register_regex($c, $re, $action)
 
+Register an individual regex on the action. Usually called from the 
+register action.
+
 =cut
 
 sub register_regex {