From: Shawn M Moore <sartak@gmail.com>
Date: Fri, 27 Jun 2008 05:04:23 +0000 (+0000)
Subject: Doc for Mouse::Role
X-Git-Tag: 0.19~265
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=cadd5b5ee44fc5a2c6456a188a1b2a48fc436a05;p=gitmo%2FMouse.git

Doc for Mouse::Role
---

diff --git a/lib/Mouse/Role.pm b/lib/Mouse/Role.pm
index 10621cc..4a9a08b 100644
--- a/lib/Mouse/Role.pm
+++ b/lib/Mouse/Role.pm
@@ -86,3 +86,56 @@ do {
 
 1;
 
+__END__
+
+=head1 NAME
+
+Mouse::Role
+
+=head1 KEYWORDS
+
+=head2 meta -> Mouse::Meta::Role
+
+Returns this role's metaclass instance.
+
+=head2 before (method|methods) => Code
+
+Sets up a "before" method modifier. See L<Moose/before> or
+L<Class::Method::Modifiers/before>.
+
+=head2 after (method|methods) => Code
+
+Sets up an "after" method modifier. See L<Moose/after> or
+L<Class::Method::Modifiers/after>.
+
+=head2 around (method|methods) => Code
+
+Sets up an "around" method modifier. See L<Moose/around> or
+L<Class::Method::Modifiers/around>.
+
+=head2 has (name|names) => parameters
+
+Sets up an attribute (or if passed an arrayref of names, multiple attributes) to
+this role. See L<Mouse/has>.
+
+=head2 confess error -> BOOM
+
+L<Carp/confess> for your convenience.
+
+=head2 blessed value -> ClassName | undef
+
+L<Scalar::Util/blessed> for your convenience.
+
+=head1 MISC
+
+=head2 import
+
+Importing Mouse::Role will give you sugar.
+
+=head2 unimport
+
+Please unimport Mouse (C<no Mouse::Role>) so that if someone calls one of the
+keywords (such as L</has>) it will break loudly instead breaking subtly.
+
+=cut
+