Checking in changes prior to tagging of version 0.40_02. Changelog diff is:

[gitmo/Mouse.git] / lib / Mouse / Spec.pm

diff --git a/lib/Mouse/Spec.pm b/lib/Mouse/Spec.pm
index 1788815..c809800 100644 (file)
--- a/lib/Mouse/Spec.pm
+++ b/lib/Mouse/Spec.pm
@@ -2,7 +2,7 @@ package Mouse::Spec;
 use strict;
 use warnings;
 
-our $VERSION = '0.35';
+our $VERSION = '0.40_02';
 
 our $MouseVersion = $VERSION;
 our $MooseVersion = '0.90';
@@ -12,3 +12,129 @@ sub MooseVersion{ $MooseVersion }
 
 1;
 __END__
+
+=head1 NAME
+
+Mouse::Spec - To what extent Mouse is compatible with Moose
+
+=head1 VERSION
+
+This document describes Mouse version 0.40_02
+
+=head1 SYNOPSIS
+
+    use Mouse::Spec;
+
+    printf "Mouse/%s is compatible with Moose/%s\n",
+        Mouse::Spec->MouseVersion, Mouse::Spec->MooseVersion;
+
+=head1 DESCRIPTION
+
+(TODO)
+
+=head2 Compatibility with Moose
+
+=head2 Incompatibility with Moose
+
+=head3 Meta object protocols
+
+Any MOP has no attributes, so
+C<< $metaclass->meta->make_immutable() >> does not yet work as you expect.
+
+=head3 Mouse::Meta::Instance
+
+Meta instance mechanism is not implemented.
+
+=head3 Role exclusion
+
+Role exclusion, C<exclude()>, is not implemented.
+
+=head3 -traits and -metaclass in Mouse::Exporter
+
+C<< use Mouse -traits => ... >> and C<< use Mouse -metaclass => ... >> are not
+yet implemented.
+
+=head2 Notes about Moose::Cookbook
+
+Many recipes in L<Moose::Cookbook> fit L<Mouse>, including:
+
+=over 4
+
+=item *
+
+L<Moose::Cookbook::Basics::Recipe1> - The (always classic) B<Point> example
+
+=item *
+
+L<Moose::Cookbook::Basics::Recipe2> - A simple B<BankAccount> example\r
+
+=item *
+
+L<Moose::Cookbook::Basics::Recipe3> - A lazy B<BinaryTree> example
+
+=item *
+
+L<Moose::Cookbook::Basics::Recipe4> - Subtypes, and modeling a simple B<Company> class hierarchy
+
+=item *
+
+L<Moose::Cookbook::Basics::Recipe5> - More subtypes, coercion in a B<Request> class\r
+
+=item *
+
+L<Moose::Cookbook::Basics::Recipe6> - The augment/inner example\r
+
+=item *
+
+L<Moose::Cookbook::Basics::Recipe7> - Making Moose fast with immutable\r
+
+=item *
+
+L<Moose::Cookbook::Basics::Recipe8> - Builder methods and lazy_build\r
+
+=item *
+
+L<Moose::Cookbook::Basics::Recipe9> - Operator overloading, subtypes, and coercion\r
+
+=item *
+
+L<Moose::Cookbook::Basics::Recipe10> - Using BUILDARGS and BUILD to hook into object construction\r
+
+=item *
+
+L<Moose::Cookbook::Roles::Recipe1> - The Moose::Role example\r
+
+=item *
+
+L<Moose::Cookbook::Roles::Recipe2> - Advanced Role Composition - method exclusion and aliasing
+
+=item *
+
+L<Moose::Cookbook::Roles::Recipe3> - Applying a role to an object instance\r
+
+=item *
+
+L<Moose::Cookbook::Meta::Recipe2> - A meta-attribute, attributes with labels\r
+
+=item *
+
+L<Moose::Cookbook::Meta::Recipe3> - Labels implemented via attribute traits\r
+
+=item *
+
+L<Moose::Cookbook::Extending::Recipe3> - Providing an alternate base object class\r
+
+=back
+
+=head1 SEE ALSO
+
+L<Mouse>
+
+L<Moose>
+
+L<Moose::Manual>
+
+L<Moose::Cookbook>
+
+=cut
+