From: Shawn M Moore <sartak@gmail.com>
Date: Tue, 2 Dec 2008 09:11:41 +0000 (+0000)
Subject: Basic doc for each module
X-Git-Tag: 0.05~50
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=09e02a3f141c879f39d31eccdff4f91e7203419a;p=gitmo%2FMooseX-Role-Parameterized.git

Basic doc for each module
---

diff --git a/lib/MooseX/Role/Parameterized/Meta/Role/Parameterizable.pm b/lib/MooseX/Role/Parameterized/Meta/Role/Parameterizable.pm
index 510ce6e..20cf586 100644
--- a/lib/MooseX/Role/Parameterized/Meta/Role/Parameterizable.pm
+++ b/lib/MooseX/Role/Parameterized/Meta/Role/Parameterizable.pm
@@ -84,3 +84,15 @@ no Moose;
 
 1;
 
+__END__
+
+=head1 DESCRIPTION
+
+This is the metaclass for parameteriz-able roles, roles that have their
+parameters currently unbound. These are the roles that you use L<Moose/with>,
+but instead of composing the parameteriz-able role, we construct a new
+parameteriz-ed role
+(L<MooseX::Role::Parameterized::Meta::Role::Parameterized>).
+
+=cut
+
diff --git a/lib/MooseX/Role/Parameterized/Meta/Role/Parameterized.pm b/lib/MooseX/Role/Parameterized/Meta/Role/Parameterized.pm
index 44ff17b..5fa6706 100644
--- a/lib/MooseX/Role/Parameterized/Meta/Role/Parameterized.pm
+++ b/lib/MooseX/Role/Parameterized/Meta/Role/Parameterized.pm
@@ -4,6 +4,8 @@ extends 'Moose::Meta::Role';
 
 # ABSTRACT: metaclass for parameterized roles
 
+use MooseX::Role::Parameterized::Parameters;
+
 has parameters => (
     is  => 'rw',
     isa => 'MooseX::Role::Parameterized::Parameters',
@@ -14,3 +16,13 @@ no Moose;
 
 1;
 
+__END__
+
+=head1 DESCRIPTION
+
+This is the metaclass for parameteriz-ed roles; that is, parameteriz-able roles
+with their parameters bound. All this actually provides is a place to store the
+L<parameters> object.
+
+=cut
+
diff --git a/lib/MooseX/Role/Parameterized/Parameters.pm b/lib/MooseX/Role/Parameterized/Parameters.pm
index ece5700..5c68878 100644
--- a/lib/MooseX/Role/Parameterized/Parameters.pm
+++ b/lib/MooseX/Role/Parameterized/Parameters.pm
@@ -8,3 +8,19 @@ no Moose;
 
 1;
 
+__END__
+
+=head1 DESCRIPTION
+
+This is the base class for parameter objects. Currently empty, but I reserve
+the right to add things here.
+
+Each parameteriz-able role gets their own anonymous subclass of this;
+L<MooseX::Role::Parameterized/parameter> actually operates on these anonymous
+subclasses.
+
+Each parameteriz-ed role gets their own instance of the anonymous subclass
+(owned by the parameteriz-able role).
+
+=cut
+