X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FMeta%2FTypeConstraint%2FEnum.pm;h=648607b72ca695ad45f2e276657e7740b223665c;hb=75d2da3428d70afc00efb0f295fd0656a05d6b9f;hp=9e07187b390474e659de48b5783200c81f14d23f;hpb=a532c4ac93ebdcbd09cd455dbb49caf8a7de1912;p=gitmo%2FMoose.git

diff --git a/lib/Moose/Meta/TypeConstraint/Enum.pm b/lib/Moose/Meta/TypeConstraint/Enum.pm
index 9e07187..648607b 100644
--- a/lib/Moose/Meta/TypeConstraint/Enum.pm
+++ b/lib/Moose/Meta/TypeConstraint/Enum.pm
@@ -6,7 +6,7 @@ use metaclass;
 
 use Moose::Util::TypeConstraints ();
 
-our $VERSION   = '0.71_01';
+our $VERSION   = '0.77';
 $VERSION = eval $VERSION;
 our $AUTHORITY = 'cpan:STEVAN';
 
@@ -82,27 +82,51 @@ __END__
 
 Moose::Meta::TypeConstraint::Enum - Type constraint for enumerated values.
 
+=head1 DESCRIPTION
+
+This class represents type constraints based on an enumerated list of
+acceptable values.
+
+=head1 INHERITANCE
+
+C<Moose::Meta::TypeConstraint::Enum> is a subclass of
+L<Moose::Meta::TypeConstraint>.
+
 =head1 METHODS
 
 =over 4
 
-=item B<new>
+=item B<< Moose::Meta::TypeConstraint::Enum->new(%options) >>
+
+This creates a new class type constraint based on the given
+C<%options>.
+
+It takes the same options as its parent, with several
+exceptions. First, it requires an additional option, C<values>. This
+should be an array reference containing a list of valid string
+values. Second, it automatically sets the parent to the C<Str> type.
+
+Finally, it ignores any provided C<constraint> option. The constraint
+is generated automatically based on the provided C<values>
 
-=item B<equals>
+=item B<< $constraint->values >>
 
-=item B<constraint>
+Returns the array reference of acceptable values provided to the
+constructor.
 
-=item B<values>
+=item B<< $constraint->create_child_type >>
 
-=item B<meta>
+This returns a new L<Moose::Meta::TypeConstraint> object with the type
+as its parent.
 
-=item B<create_child_type>
+Note that it does I<not> return a C<Moose::Meta::TypeConstraint::Enum>
+object!
 
 =back
 
 =head1 BUGS
 
-All complex software has bugs lurking in it, and this module is no 
+All complex software has bugs lurking in it, and this module is no
 exception. If you find a bug please either email me, or add the bug
 to cpan-RT.