[Catalyst-commits] r9702 - in Catalyst-Runtime/5.80/trunk/lib/Catalyst: . DispatchType

[ijw at dev.catalyst.perl.org]

Author: ijw
Date: 2009-04-14 23:44:42 +0100 (Tue, 14 Apr 2009)
New Revision: 9702

Modified:
   Catalyst-Runtime/5.80/trunk/lib/Catalyst/DispatchType.pm
   Catalyst-Runtime/5.80/trunk/lib/Catalyst/DispatchType/Chained.pm
   Catalyst-Runtime/5.80/trunk/lib/Catalyst/DispatchType/Default.pm
   Catalyst-Runtime/5.80/trunk/lib/Catalyst/DispatchType/Index.pm
   Catalyst-Runtime/5.80/trunk/lib/Catalyst/DispatchType/Path.pm
   Catalyst-Runtime/5.80/trunk/lib/Catalyst/DispatchType/Regex.pm
Log:
DispatchTypes' POD refers to Catalyst::Manual::Intro, nominated as the best location to put action/dispatch information

Modified: Catalyst-Runtime/5.80/trunk/lib/Catalyst/DispatchType/Chained.pm
===================================================================
--- Catalyst-Runtime/5.80/trunk/lib/Catalyst/DispatchType/Chained.pm	2009-04-14 22:42:13 UTC (rev 9701)
+++ Catalyst-Runtime/5.80/trunk/lib/Catalyst/DispatchType/Chained.pm	2009-04-14 22:44:42 UTC (rev 9702)
@@ -39,6 +39,8 @@
 
 =head1 SYNOPSIS
 
+Path part matching, allowing several actions to sequentially take care of processing a request:
+
   #   root action - captures one argument after it
   sub foo_setup : Chained('/') PathPart('foo') CaptureArgs(1) {
       my ( $self, $c, $foo_arg ) = @_;
@@ -53,8 +55,17 @@
 
 =head1 DESCRIPTION
 
-See L</USAGE>.
+Dispatch type managing default behaviour.  For more information on
+dispatch types, see:
 
+=over 4
+
+=item * L<Catalyst::Manual::Intro> for how they affect website authors
+
+=item * L<Catalyst::DispatchType> for implementation information.
+
+=back
+
 =head1 METHODS
 
 =head2 $self->list($c)

Modified: Catalyst-Runtime/5.80/trunk/lib/Catalyst/DispatchType/Default.pm
===================================================================
--- Catalyst-Runtime/5.80/trunk/lib/Catalyst/DispatchType/Default.pm	2009-04-14 22:42:13 UTC (rev 9701)
+++ Catalyst-Runtime/5.80/trunk/lib/Catalyst/DispatchType/Default.pm	2009-04-14 22:44:42 UTC (rev 9702)
@@ -11,10 +11,21 @@
 
 =head1 SYNOPSIS
 
-See L<Catalyst>.
+See L<Catalyst::DispatchType>.
 
 =head1 DESCRIPTION
 
+Dispatch type managing default behaviour.  For more information on
+dispatch types, see:
+
+=over 4
+
+=item * L<Catalyst::Manual::Intro> for how they affect website authors
+
+=item * L<Catalyst::DispatchType> for implementation information.
+
+=back
+
 =head1 METHODS
 
 =head2 $self->match( $c, $path )

Modified: Catalyst-Runtime/5.80/trunk/lib/Catalyst/DispatchType/Index.pm
===================================================================
--- Catalyst-Runtime/5.80/trunk/lib/Catalyst/DispatchType/Index.pm	2009-04-14 22:42:13 UTC (rev 9701)
+++ Catalyst-Runtime/5.80/trunk/lib/Catalyst/DispatchType/Index.pm	2009-04-14 22:44:42 UTC (rev 9702)
@@ -10,10 +10,21 @@
 
 =head1 SYNOPSIS
 
-See L<Catalyst>.
+See L<Catalyst::DispatchType>.
 
 =head1 DESCRIPTION
 
+Dispatch type managing behaviour for index pages.  For more information on
+dispatch types, see:
+
+=over 4
+
+=item * L<Catalyst::Manual::Intro> for how they affect website authors
+
+=item * L<Catalyst::DispatchType> for implementation information.
+
+=back
+
 =head1 METHODS
 
 =head2 $self->match( $c, $path )

Modified: Catalyst-Runtime/5.80/trunk/lib/Catalyst/DispatchType/Path.pm
===================================================================
--- Catalyst-Runtime/5.80/trunk/lib/Catalyst/DispatchType/Path.pm	2009-04-14 22:42:13 UTC (rev 9701)
+++ Catalyst-Runtime/5.80/trunk/lib/Catalyst/DispatchType/Path.pm	2009-04-14 22:44:42 UTC (rev 9702)
@@ -22,10 +22,21 @@
 
 =head1 SYNOPSIS
 
-See L<Catalyst>.
+See L<Catalyst::DispatchType>.
 
 =head1 DESCRIPTION
 
+Dispatch type managing full path matching behaviour.  For more information on
+dispatch types, see:
+
+=over 4
+
+=item * L<Catalyst::Manual::Intro> for how they affect website authors
+
+=item * L<Catalyst::DispatchType> for implementation information.
+
+=back
+
 =head1 METHODS
 
 =head2 $self->list($c)

Modified: Catalyst-Runtime/5.80/trunk/lib/Catalyst/DispatchType/Regex.pm
===================================================================
--- Catalyst-Runtime/5.80/trunk/lib/Catalyst/DispatchType/Regex.pm	2009-04-14 22:42:13 UTC (rev 9701)
+++ Catalyst-Runtime/5.80/trunk/lib/Catalyst/DispatchType/Regex.pm	2009-04-14 22:44:42 UTC (rev 9702)
@@ -22,10 +22,21 @@
 
 =head1 SYNOPSIS
 
-See L<Catalyst>.
+See L<Catalyst::DispatchType>.
 
 =head1 DESCRIPTION
 
+Dispatch type managing path-matching behaviour using regexes.  For
+more information on dispatch types, see:
+
+=over 4
+
+=item * L<Catalyst::Manual::Intro> for how they affect website authors
+
+=item * L<Catalyst::DispatchType> for implementation information.
+
+=back
+
 =head1 METHODS
 
 =head2 $self->list($c)

Modified: Catalyst-Runtime/5.80/trunk/lib/Catalyst/DispatchType.pm
===================================================================
--- Catalyst-Runtime/5.80/trunk/lib/Catalyst/DispatchType.pm	2009-04-14 22:42:13 UTC (rev 9701)
+++ Catalyst-Runtime/5.80/trunk/lib/Catalyst/DispatchType.pm	2009-04-14 22:44:42 UTC (rev 9702)
@@ -14,8 +14,13 @@
 
 =head1 DESCRIPTION
 
-This is an abstract base class for Dispatch Types. 
+This is an abstract base class for Dispatch Types.
 
+From a code perspective, dispatch types are used to find which actions
+to call for a given request URL.  Website authors will typically work
+with them via subroutine names attributes; a description of dispatch
+at the attribute/URL level is given in L<Catalyst::Manual::Intro>.
+
 =head1 METHODS
 
 =head2 $self->list($c)