From: Paul Driver <frodwith@gmail.com>
Date: Fri, 11 Apr 2008 14:42:17 +0000 (+0000)
Subject: Docs tentatively finished.
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=1d458eb89d4352782c06b7535c6d787015130fcf;p=gitmo%2FMooseX-AttributeHelpers.git

Docs tentatively finished.
---

diff --git a/lib/MooseX/AttributeHelpers/Collection/Array.pm b/lib/MooseX/AttributeHelpers/Collection/Array.pm
index 8a83eaa..51e7d94 100644
--- a/lib/MooseX/AttributeHelpers/Collection/Array.pm
+++ b/lib/MooseX/AttributeHelpers/Collection/Array.pm
@@ -49,7 +49,7 @@ array operations.
 =head1 PROVIDED METHODS
 
 The methods for this metaclass are provided by
-L<MooseX::AttributeHelpers::MethodProvider::Array>.
+L<MooseX::AttributeHelpers::MethodProvider::Collection::Array>.
 
 =head1 BUGS
 
diff --git a/lib/MooseX/AttributeHelpers/Collection/Bag.pm b/lib/MooseX/AttributeHelpers/Collection/Bag.pm
index 96d0ba8..29c364b 100644
--- a/lib/MooseX/AttributeHelpers/Collection/Bag.pm
+++ b/lib/MooseX/AttributeHelpers/Collection/Bag.pm
@@ -53,7 +53,7 @@ for more details.
 =head1 PROVIDED METHODS
 
 The methods for this metaclass are provided by
-L<MooseX::AttributeHelpers::MethodProvider::Bag>.
+L<MooseX::AttributeHelpers::MethodProvider::Collection::Bag>.
 
 =head1 BUGS
 
diff --git a/lib/MooseX/AttributeHelpers/Collection/Hash.pm b/lib/MooseX/AttributeHelpers/Collection/Hash.pm
index 5babe6b..502c94a 100644
--- a/lib/MooseX/AttributeHelpers/Collection/Hash.pm
+++ b/lib/MooseX/AttributeHelpers/Collection/Hash.pm
@@ -47,13 +47,12 @@ MooseX::AttributeHelpers::Collection::Hash
 =head1 DESCRIPTION
 
 This module provides an Hash attribute which provides a number of 
-hash-like operations. See L<MooseX::AttributeHelpers::MethodProvider::Hash>
-for more details.
+hash-like operations. 
 
 =head1 PROVIDED METHODS
 
 The methods for this metaclass are provided by
-L<MooseX::AttributeHelpers::MethodProvider::Hash>.
+L<MooseX::AttributeHelpers::MethodProvider::Collection::Hash>.
 
 =head1 BUGS
 
diff --git a/lib/MooseX/AttributeHelpers/Collection/ImmutableHash.pm b/lib/MooseX/AttributeHelpers/Collection/ImmutableHash.pm
index 0c75d55..d0a8625 100644
--- a/lib/MooseX/AttributeHelpers/Collection/ImmutableHash.pm
+++ b/lib/MooseX/AttributeHelpers/Collection/ImmutableHash.pm
@@ -50,7 +50,7 @@ hash-like operations.
 =head1 PROVIDED METHODS
 
 The methods for this metaclass are provided by
-L<MooseX::AttributeHelpers::MethodProvider::ImmutableHash>.
+L<MooseX::AttributeHelpers::MethodProvider::Collection::ImmutableHash>.
 
 =head1 BUGS
 
diff --git a/lib/MooseX/AttributeHelpers/Collection/List.pm b/lib/MooseX/AttributeHelpers/Collection/List.pm
index 687a3ed..b9c3ac0 100644
--- a/lib/MooseX/AttributeHelpers/Collection/List.pm
+++ b/lib/MooseX/AttributeHelpers/Collection/List.pm
@@ -37,7 +37,7 @@ MooseX::AttributeHelpers::Collection::List
       default   => sub { [] },
       provides  => {
           map  => 'map_options',
-          grep => 'fitler_options',
+          grep => 'filter_options',
       }
   );
 
@@ -49,7 +49,7 @@ list operations.
 =head1 PROVIDED METHODS
 
 The methods for this metaclass are provided by
-L<MooseX::AttributeHelpers::MethodProvider::List>.
+L<MooseX::AttributeHelpers::MethodProvider::Collection::List>.
 
 =head1 BUGS
 
diff --git a/lib/MooseX/AttributeHelpers/MethodProvider/Collection/Array.pm b/lib/MooseX/AttributeHelpers/MethodProvider/Collection/Array.pm
index 63cba56..7111bf1 100644
--- a/lib/MooseX/AttributeHelpers/MethodProvider/Collection/Array.pm
+++ b/lib/MooseX/AttributeHelpers/MethodProvider/Collection/Array.pm
@@ -85,12 +85,14 @@ __END__
 
 =head1 NAME
 
-MooseX::AttributeHelpers::MethodProvider::Array
+MooseX::AttributeHelpers::MethodProvider::Collection::Array
 
 =head1 DESCRIPTION
 
-This is a role which provides the method generators for
-L<MooseX::AttributeHelpers::Collection::Array>.
+This module provides the method factories for
+L<MooseX::AttributeHelpers::Collection::Array>.  It also consumes
+L<MooseX::AttributeHelpers::MethodProvider::Collection::List>, and thus
+provides all its methods as well.
 
 =head1 PROVIDED METHODS
 
diff --git a/lib/MooseX/AttributeHelpers/MethodProvider/Collection/Bag.pm b/lib/MooseX/AttributeHelpers/MethodProvider/Collection/Bag.pm
index ff6b780..fb2e1de 100644
--- a/lib/MooseX/AttributeHelpers/MethodProvider/Collection/Bag.pm
+++ b/lib/MooseX/AttributeHelpers/MethodProvider/Collection/Bag.pm
@@ -41,10 +41,10 @@ MooseX::AttributeHelpers::MethodProvider::Bag
 
 =head1 DESCRIPTION
 
-This is a role which provides the method generators for
+This module provides the method factories for
 L<MooseX::AttributeHelpers::Collection::Bag>.  It also consumes
-L<MooseX::AttributeHelpers::Collection::ImmutableHash>, and thus provides all
-of its methods asw well.
+L<MooseX::AttributeHelpers::MethodProvider::Collection::ImmutableHash>, 
+and thus provides all of its methods as well.
 
 =head1 PROVIDED METHODS
 
diff --git a/lib/MooseX/AttributeHelpers/MethodProvider/Collection/Hash.pm b/lib/MooseX/AttributeHelpers/MethodProvider/Collection/Hash.pm
index b323706..dbcd55f 100644
--- a/lib/MooseX/AttributeHelpers/MethodProvider/Collection/Hash.pm
+++ b/lib/MooseX/AttributeHelpers/MethodProvider/Collection/Hash.pm
@@ -54,10 +54,10 @@ MooseX::AttributeHelpers::MethodProvider::Hash
 
 =head1 DESCRIPTION
 
-This is a role which provides the method generators for
-L<MooseX::AttributeHelpers::Collection::Hash>.  It consumes
-L<MooseX::AttributeHelpers::MethodProvider::ImmutableHash>, and thus
-provides all its methods as wel.
+This module provides the method factories for
+L<MooseX::AttributeHelpers::Collection::Hash>.  It also consumes
+L<MooseX::AttributeHelpers::MethodProvider::Collection::ImmutableHash>, and 
+thus provides all its methods as well.
 
 =head1 PROVIDED METHODS
 
diff --git a/lib/MooseX/AttributeHelpers/MethodProvider/Collection/ImmutableHash.pm b/lib/MooseX/AttributeHelpers/MethodProvider/Collection/ImmutableHash.pm
index 42c789a..d3b03a8 100644
--- a/lib/MooseX/AttributeHelpers/MethodProvider/Collection/ImmutableHash.pm
+++ b/lib/MooseX/AttributeHelpers/MethodProvider/Collection/ImmutableHash.pm
@@ -75,7 +75,7 @@ MooseX::AttributeHelpers::MethodProvider::ImmutableHash
 
 =head1 DESCRIPTION
 
-This is a role which provides the method generators for
+This module provides the method factories for
 L<MooseX::AttributeHelpers::Collection::ImmutableHash>.
 
 =head1 PROVIDED METHODS
diff --git a/lib/MooseX/AttributeHelpers/MethodProvider/Collection/List.pm b/lib/MooseX/AttributeHelpers/MethodProvider/Collection/List.pm
index b454350..806ac51 100644
--- a/lib/MooseX/AttributeHelpers/MethodProvider/Collection/List.pm
+++ b/lib/MooseX/AttributeHelpers/MethodProvider/Collection/List.pm
@@ -69,7 +69,7 @@ MooseX::AttributeHelpers::MethodProvider::List
 
 =head1 DESCRIPTION
 
-This is a role which provides the method generators for
+This module provides the method factories for
 L<MooseX::AttributeHelpers::Collection::List>.
 
 =head1 PROVIDED METHODS
diff --git a/lib/MooseX/AttributeHelpers/MethodProvider/Counter.pm b/lib/MooseX/AttributeHelpers/MethodProvider/Counter.pm
index a90edb9..0aa8fbc 100644
--- a/lib/MooseX/AttributeHelpers/MethodProvider/Counter.pm
+++ b/lib/MooseX/AttributeHelpers/MethodProvider/Counter.pm
@@ -36,7 +36,7 @@ MooseX::AttributeHelpers::MethodProvider::Counter
 
 =head1 DESCRIPTION
 
-This is a role which provides the method generators for
+This module provides the method factories for 
 L<MooseX::AttributeHelpers::Counter>.
 
 =head1 PROVIDED METHODS
diff --git a/lib/MooseX/AttributeHelpers/MethodProvider/Number.pm b/lib/MooseX/AttributeHelpers/MethodProvider/Number.pm
index c9be4aa..82a30d9 100644
--- a/lib/MooseX/AttributeHelpers/MethodProvider/Number.pm
+++ b/lib/MooseX/AttributeHelpers/MethodProvider/Number.pm
@@ -37,7 +37,7 @@ MooseX::AttributeHelpers::MethodProvider::Number
 
 =head1 DESCRIPTION
 
-This is a role which provides the method generators for
+This module provides the method factories for
 L<MooseX::AttributeHelpers::Number>.
 
 =head1 PROVIDED METHODS
@@ -62,7 +62,7 @@ where OP is the operator listed next to the method name.
 
 =item B<set>
 
-A way to set the value instead of 'setter' or 'is => "rw"'.  This method is
+A way to set the value instead of C<setter> or C<is =&gt; 'rw'>.  This method is
 provided for convenience.
 
 =back
diff --git a/lib/MooseX/AttributeHelpers/MethodProvider/String.pm b/lib/MooseX/AttributeHelpers/MethodProvider/String.pm
index 202c646..2ff2023 100644
--- a/lib/MooseX/AttributeHelpers/MethodProvider/String.pm
+++ b/lib/MooseX/AttributeHelpers/MethodProvider/String.pm
@@ -84,7 +84,7 @@ MooseX::AttributeHelpers::MethodProvider::String
 
 =head1 DESCRIPTION
 
-This is a role which provides the method generators for
+This module provides the method factories for
 L<MooseX::AttributeHelpers::String>.
 
 =head1 PROVIDED METHODS