bump version to 1.14

[gitmo/Moose.git] / lib / Moose / Meta / TypeConstraint / Parameterizable.pm

diff --git a/lib/Moose/Meta/TypeConstraint/Parameterizable.pm b/lib/Moose/Meta/TypeConstraint/Parameterizable.pm
index 02b49eb..7a5d978 100644 (file)
--- a/lib/Moose/Meta/TypeConstraint/Parameterizable.pm
+++ b/lib/Moose/Meta/TypeConstraint/Parameterizable.pm
@@ -4,7 +4,7 @@ use strict;
 use warnings;
 use metaclass;
 
-our $VERSION   = '0.71';
+our $VERSION   = '1.14';
 $VERSION = eval $VERSION;
 our $AUTHORITY = 'cpan:STEVAN';
 
@@ -19,16 +19,16 @@ __PACKAGE__->meta->add_attribute('constraint_generator' => (
 
 sub generate_constraint_for {
     my ($self, $type) = @_;
-    
+
     return unless $self->has_constraint_generator;
-    
+
     return $self->constraint_generator->($type->type_parameter)
         if $type->is_subtype_of($self->name);
-        
+
     return $self->_can_coerce_constraint_from($type)
         if $self->has_coercion
         && $self->coercion->has_coercion_for_type($type->parent->name);
-        
+
     return;
 }
 
@@ -51,10 +51,10 @@ sub parameterize {
     my ($self, $type_parameter) = @_;
 
     my $contained_tc = $self->_parse_type_parameter($type_parameter);
-    
+
     ## The type parameter should be a subtype of the parent's type parameter
     ## if there is one.
-    
+
     if(my $parent = $self->parent) {
         if($parent->can('type_parameter')) {
             unless ( $contained_tc->is_a_type_of($parent->type_parameter) ) {
@@ -88,32 +88,33 @@ __END__
 
 =head1 NAME
 
-Moose::Meta::TypeConstraint::Parameterizable - Higher Order type constraints for Moose
-
-=head1 METHODS
+Moose::Meta::TypeConstraint::Parameterizable - Type constraints which can take a parameter (ArrayRef)
 
-=over 4
+=head1 DESCRIPTION
 
-=item B<constraint_generator>
+This class represents a parameterizable type constraint. This is a
+type constraint like C<ArrayRef> or C<HashRef>, that can be
+parameterized and made more specific by specifying a contained
+type. For example, instead of just an C<ArrayRef> of anything, you can
+specify that is an C<ArrayRef[Int]>.
 
-=item B<has_constraint_generator>
+A parameterizable constraint should not be used as an attribute type
+constraint. Instead, when parameterized it creates a
+L<Moose::Meta::TypeConstraint::Parameterized> which should be used.
 
-=item B<generate_constraint_for>
+=head1 INHERITANCE
 
-=item B<parameterize>
+C<Moose::Meta::TypeConstraint::Parameterizable> is a subclass of
+L<Moose::Meta::TypeConstraint>.
 
-Given a single type constraint or type constraint string, this method
-parameterizes the type based on the given argument.
-
-=item B<meta>
+=head1 METHODS
 
-=back
+This class is intentionally not documented because the API is
+confusing and needs some work.
 
 =head1 BUGS
 
-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.
+See L<Moose/BUGS> for details on reporting bugs.
 
 =head1 AUTHOR
 
@@ -121,7 +122,7 @@ Stevan Little E<lt>stevan@iinteractive.comE<gt>
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2006-2009 by Infinity Interactive, Inc.
+Copyright 2006-2010 by Infinity Interactive, Inc.
 
 L<http://www.iinteractive.com>