[Bps-public-commit] r17444 - in Path-Dispatcher/trunk: lib/Path/Dispatcher

[sartak at bestpractical.com]

Author: sartak
Date: Tue Dec 30 14:21:11 2008
New Revision: 17444

Modified:
   Path-Dispatcher/trunk/   (props changed)
   Path-Dispatcher/trunk/lib/Path/Dispatcher/Path.pm

Log:
 r78062 at onn:  sartak | 2008-12-29 23:57:41 -0500
 Some doc for Path::Dispatcher::Path


Modified: Path-Dispatcher/trunk/lib/Path/Dispatcher/Path.pm
==============================================================================
--- Path-Dispatcher/trunk/lib/Path/Dispatcher/Path.pm	(original)
+++ Path-Dispatcher/trunk/lib/Path/Dispatcher/Path.pm	Tue Dec 30 14:21:11 2008
@@ -37,3 +37,35 @@
 
 1;
 
+__END__
+
+=head1 NAME
+
+Path::Dispatcher::Path - path and some optional metadata
+
+=head1 SYNOPSIS
+
+    my $path = Path::Dispatcher::Path->new(
+        path     => "/REST/Ticket/1",
+        metadata => {
+            http_method => "DELETE",
+        },
+    );
+
+    $path->path;                        # /REST/Ticket/1
+    $path->get_metadata("http_method"); # DELETE
+
+=head1 ATTRIBUTES
+
+=head2 path
+
+A string representing the path. C<Path::Dispatcher::Path> is basically a boxed
+string. :)
+
+=head2 metadata
+
+A hash representing arbitrary metadata. The L<Path::Dispatcher::Rule::Metadata>
+rule is designed to match against members of this hash.
+
+=cut
+