From: Dave Rolsky <autarch@houseabsolute.urth.org>
Date: Tue, 24 Mar 2009 21:03:04 +0000 (-0500)
Subject: docs for Moose::Meta::Role::Composite
X-Git-Tag: 0.72_01~26
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=da5cc4866ad96cdc412bc495118fd38fc85a3f35;p=gitmo%2FMoose.git

docs for Moose::Meta::Role::Composite
---

diff --git a/lib/Moose/Meta/Role/Composite.pm b/lib/Moose/Meta/Role/Composite.pm
index ab39e4f..b7262fe 100644
--- a/lib/Moose/Meta/Role/Composite.pm
+++ b/lib/Moose/Meta/Role/Composite.pm
@@ -86,19 +86,36 @@ Moose::Meta::Role::Composite - An object to represent the set of roles
 
 =head1 DESCRIPTION
 
+A composite is a role that consists of a set of two or more roles.
+
+The API of a composite role is almost identical to that of a regular
+role.
+
+=head1 INHERITANCE
+
+C<Moose::Meta::Role::Composite> is a subclass of L<Moose::Meta::Role>.
+
 =head2 METHODS
 
 =over 4
 
-=item B<new>
+=item B<< Moose::Meta::Role::Composite->new(%options) >>
 
-=item B<meta>
+This returns a new composite role object. It accepts the same
+options as its parent class, with a few changes:
 
-=item B<name>
+=over 8
 
-=item B<get_method_map>
+=item * roles
 
-=item B<add_method>
+This option is an array reference containing a list of
+L<Moose::Meta::Role> object. This is a required option.
+
+=item * name
+
+If a name is not given, one is generated from the roles provided.
+
+=back
 
 =back
 
diff --git a/xt/pod_coverage.t b/xt/pod_coverage.t
index 8969c75..0517bf5 100644
--- a/xt/pod_coverage.t
+++ b/xt/pod_coverage.t
@@ -55,7 +55,8 @@ my %trustme = (
             wrap_method_body
             )
     ],
-    'Moose::Role' => [
+    'Moose::Meta::Role::Composite' => ['add_method'],
+    'Moose::Role'                  => [
         qw( after
             around
             augment