From: gfx <gfuji@cpan.org>
Date: Sat, 11 Sep 2010 07:14:43 +0000 (+0900)
Subject: Docs
X-Git-Tag: 0.68~1
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=503ed64839f2938fc29e8bfbfb21f631a0c4ccda;p=gitmo%2FMouse.git

Docs
---

diff --git a/lib/Mouse/Meta/Attribute.pm b/lib/Mouse/Meta/Attribute.pm
index 03c0e0a..ad30339 100644
--- a/lib/Mouse/Meta/Attribute.pm
+++ b/lib/Mouse/Meta/Attribute.pm
@@ -358,6 +358,11 @@ Mouse::Meta::Attribute - The Mouse attribute metaclass
 
 This document describes Mouse version 0.67
 
+=head1 DESCRIPTION
+
+This is a meta object protocol for Mouse attributes,
+which is a subset of Moose::Meta::Attribute.
+
 =head1 METHODS
 
 =head2 C<< new(%options) -> Mouse::Meta::Attribute >>
diff --git a/lib/Mouse/Meta/Class.pm b/lib/Mouse/Meta/Class.pm
index af32473..b815ea8 100644
--- a/lib/Mouse/Meta/Class.pm
+++ b/lib/Mouse/Meta/Class.pm
@@ -435,6 +435,11 @@ Mouse::Meta::Class - The Mouse class metaclass
 
 This document describes Mouse version 0.67
 
+=head1 DESCRIPTION
+
+This class is a meta object protocol for Mouse classes,
+which is a subset of Moose::Meta:::Class.
+
 =head1 METHODS
 
 =head2 C<< initialize(ClassName) -> Mouse::Meta::Class >>
diff --git a/lib/Mouse/Meta/Method.pm b/lib/Mouse/Meta/Method.pm
index aec0cf6..7d68298 100755
--- a/lib/Mouse/Meta/Method.pm
+++ b/lib/Mouse/Meta/Method.pm
@@ -56,6 +56,11 @@ Mouse::Meta::Method - A Mouse Method metaclass
 
 This document describes Mouse version 0.67
 
+=head1 DESCRIPTION
+
+This class is a meta object protocol for Mouse methods,
+which is a subset of Moose::Meta:::Method.
+
 =head1 SEE ALSO
 
 L<Moose::Meta::Method>
diff --git a/lib/Mouse/Meta/Module.pm b/lib/Mouse/Meta/Module.pm
index b906498..fe65a62 100755
--- a/lib/Mouse/Meta/Module.pm
+++ b/lib/Mouse/Meta/Module.pm
@@ -331,6 +331,11 @@ Mouse::Meta::Module - The base class for Mouse::Meta::Class and Mouse::Meta::Rol
 
 This document describes Mouse version 0.67
 
+=head1 DESCRIPTION
+
+This class is a base class of Mouse classes and roles,
+which is a subset of Class::MOP::Class.
+
 =head1 SEE ALSO
 
 L<Class::MOP::Class>
diff --git a/lib/Mouse/Meta/Role.pm b/lib/Mouse/Meta/Role.pm
index 5320ea5..de20305 100644
--- a/lib/Mouse/Meta/Role.pm
+++ b/lib/Mouse/Meta/Role.pm
@@ -314,6 +314,11 @@ Mouse::Meta::Role - The Mouse Role metaclass
 
 This document describes Mouse version 0.67
 
+=head1 DESCRIPTION
+
+This class is a meta object protocol for Mouse roles,
+which is a subset of Moose::Meta:::Role.
+
 =head1 SEE ALSO
 
 L<Moose::Meta::Role>
diff --git a/lib/Mouse/Spec.pm b/lib/Mouse/Spec.pm
index 0d3f2d5..acee720 100644
--- a/lib/Mouse/Spec.pm
+++ b/lib/Mouse/Spec.pm
@@ -31,19 +31,24 @@ This document describes Mouse version 0.67
 =head1 DESCRIPTION
 
 Mouse is a subset of Moose. This document describes to what extend Mouse is
-compatible with Moose.
+compatible (and incompatible) with Moose.
 
 =head2 Compatibility with Moose
 
-The sugary API is highly compatible with Moose.
+The sugary API is highly compatible with Moose. Methods which have the
+same name as Moose's are expected to be compatible with Moose's.
 
 =head2 Incompatibility with Moose
 
 =head3 Meta object protocols
 
-Any MOP in Mouse has no attributes by default.
+Meta object protocols are a subset of the counterpart of Moose.
+Their methods which have the same name as Moose's are expected to be
+compatible with Moose's. Feel free to use these methods even if they
+are not documented.
 
-For this reason, C<< $metaclass->meta->make_immutable() >> does not yet work as you expect.
+However, meta object protocols in Mouse have no attributes by default,
+so C<< $metaclass->meta->make_immutable() >> will not work as you expect.
 B<Don not make metaclasses immutable>.
 
 =head3 Mouse::Meta::Instance