summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authordoy <doy@tozt.net>2008-12-07 00:47:44 -0500
committerdoy <doy@tozt.net>2008-12-07 00:47:44 -0500
commitc745c4dcac97c5373e8263ecd00881889e32779b (patch)
tree35c49e59fc0a281645902df58fcc3f5de7941598
parent3af700804cef2e274364ab78d588a2b51f05e080 (diff)
downloadmoosex-role-matcher-c745c4dcac97c5373e8263ecd00881889e32779b.tar.gz
moosex-role-matcher-c745c4dcac97c5373e8263ecd00881889e32779b.zip
description
-rw-r--r--lib/MooseX/Role/Matcher.pm20
1 files changed, 17 insertions, 3 deletions
diff --git a/lib/MooseX/Role/Matcher.pm b/lib/MooseX/Role/Matcher.pm
index b54e490..5eb391f 100644
--- a/lib/MooseX/Role/Matcher.pm
+++ b/lib/MooseX/Role/Matcher.pm
@@ -38,11 +38,25 @@ use List::MoreUtils qw/any all/;
=head1 DESCRIPTION
-=cut
+This role adds flexible matching and searching capabilities to your Moose
+class. It provides a match method, which tests attributes and methods of your
+object against strings, regexes, or coderefs, and also provides several class
+methods for using match on lists of objects.
+
+=head2 PARAMETERS
+
+MooseX::Role::Matcher is a parameterized role (see
+L<MooseX::Role::Parameterized>). The parameters it takes are:
-=head1 PARAMETERS
+=over
-=head2 default_match
+=item default_match
+
+Which attribute/method to test against by default, if none are specified
+explicitly. Setting default_match to 'foo' allows using $obj->match('bar')
+rather than $obj->match(foo => 'bar').
+
+=back
=cut