Add descriptions to pods

diff --git a/lib/Mouse/Meta/Attribute.pm b/lib/Mouse/Meta/Attribute.pm
index fc1cb8f..490018b 100644 (file)
--- a/lib/Mouse/Meta/Attribute.pm
+++ b/lib/Mouse/Meta/Attribute.pm
@@ -486,6 +486,13 @@ is equivalent to this:
 
 =back
 
+=head2 C<< associate_method(Method) >>
+
+Associates a method with the attribute. Typically, this is called internally
+when an attribute generates its accessors.
+
+Currently the argument I<Method> is ignored in Mouse.
+
 =head2 C<< verify_against_type_constraint(Item) -> TRUE | ERROR >>
 
 Checks that the given value passes this attribute's type constraint. Returns C<true>
@@ -500,5 +507,7 @@ Accessors and helper methods are installed. Some error checking is done.
 
 L<Moose::Meta::Attribute>
 
+L<Class::MOP::Attribute>
+
 =cut
 

diff --git a/lib/Mouse/Meta/Class.pm b/lib/Mouse/Meta/Class.pm
index ca8676a..c7c4433 100644 (file)
--- a/lib/Mouse/Meta/Class.pm
+++ b/lib/Mouse/Meta/Class.pm
@@ -443,7 +443,7 @@ Mouse::Meta::Class - The Mouse class metaclass
 
 =head2 C<< initialize(ClassName) -> Mouse::Meta::Class >>
 
-Finds or creates a Mouse::Meta::Class instance for the given ClassName. Only
+Finds or creates a C<Mouse::Meta::Class> instance for the given ClassName. Only
 one instance should exist for a given class.
 
 =head2 C<< name -> ClassName >>
@@ -454,30 +454,55 @@ Returns the name of the owner class.
 
 Gets (or sets) the list of superclasses of the owner class.
 
-=head2 C<< add_attribute(name => spec | Mouse::Meta::Attribute) >>
+=head2 C<< add_method(name => CodeRef) >>
 
-Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner
-class.
+Adds a method to the owner class.
 
-=head2 C<< get_all_attributes -> (Mouse::Meta::Attribute) >>
+=head2 C<< has_method(name) -> Bool >>
 
-Returns the list of all L<Mouse::Meta::Attribute> instances associated with
-this class and its superclasses.
+Returns whether we have a method with the given name.
 
-=head2 C<< get_attribute_list -> { name => Mouse::Meta::Attribute } >>
+=head2 C<< get_method(name) -> Mouse::Meta::Method | undef >>
 
-This returns a list of attribute names which are defined in the local
-class. If you want a list of all applicable attributes for a class,
-use the C<get_all_attributes> method.
+Returns a L<Mouse::Meta::Method> with the given name.
+
+Note that you can also use C<< $metaclass->name->can($name) >> for a method body.
+
+=head2 C<< get_method_list -> Names >>
+
+Returns a list of method names which are defined in the local class.
+If you want a list of all applicable methods for a class, use the
+C<get_all_methods> method.
+
+=head2 C<< get_all_methods -> (Mouse::Meta::Method) >>
+
+Return the list of all L<Mouse::Meta::Method> instances associated with
+the class and its superclasses.
+
+=head2 C<< add_attribute(name => spec | Mouse::Meta::Attribute) >>
+
+Begins keeping track of the existing L<Mouse::Meta::Attribute> for the owner
+class.
 
 =head2 C<< has_attribute(Name) -> Bool >>
 
 Returns whether we have a L<Mouse::Meta::Attribute> with the given name.
 
-=head2 get_attribute Name -> Mouse::Meta::Attribute | undef
+=head2 C<< get_attribute Name -> Mouse::Meta::Attribute | undef >>
 
 Returns the L<Mouse::Meta::Attribute> with the given name.
 
+=head2 C<< get_attribute_list -> Names >>
+
+Returns a list of attribute names which are defined in the local
+class. If you want a list of all applicable attributes for a class,
+use the C<get_all_attributes> method.
+
+=head2 C<< get_all_attributes -> (Mouse::Meta::Attribute) >>
+
+Returns the list of all L<Mouse::Meta::Attribute> instances associated with
+this class and its superclasses.
+
 =head2 C<< linearized_isa -> [ClassNames] >>
 
 Returns the list of classes in method dispatch order, with duplicates removed.
@@ -488,12 +513,18 @@ Creates a new instance.
 
 =head2 C<< clone_object(Instance, Parameters) -> Instance >>
 
-Clones the given C<Instance> which must be an instance governed by this
+Clones the given instance which must be an instance governed by this
 metaclass.
 
+=head2 C<< throw_error(Message, Parameters) >>
+
+Throws an error with the given message.
+
 =head1 SEE ALSO
 
 L<Moose::Meta::Class>
 
+L<Class::MOP::Class>
+
 =cut
 

diff --git a/lib/Mouse/Meta/Method.pm b/lib/Mouse/Meta/Method.pm
index 21cff59..a018662 100755 (executable)
--- a/lib/Mouse/Meta/Method.pm
+++ b/lib/Mouse/Meta/Method.pm
@@ -36,4 +36,6 @@ Mouse::Meta::Method - A Mouse Method metaclass
 
 L<Moose::Meta::Method>
 
+L<Class::MOP::Method>
+
 =cut

diff --git a/lib/Mouse/Meta/Module.pm b/lib/Mouse/Meta/Module.pm
index c102596..79998a3 100755 (executable)
--- a/lib/Mouse/Meta/Module.pm
+++ b/lib/Mouse/Meta/Module.pm
@@ -308,7 +308,11 @@ Mouse::Meta::Module - The base class for Mouse::Meta::Class and Mouse::Meta::Rol
 
 =head1 SEE ALSO
 
-L<Class::MOP>
+L<Class::MOP::Class>
+
+L<Class::MOP::Module>
+
+L<Class::MOP::Package>
 
 =cut
 

diff --git a/lib/Mouse/Object.pm b/lib/Mouse/Object.pm
index f68f390..f1cd27e 100644 (file)
--- a/lib/Mouse/Object.pm
+++ b/lib/Mouse/Object.pm
@@ -81,21 +81,21 @@ Mouse::Object - we don't need to steenkin' constructor
 
 =head1 METHODS
 
-=head2 C<< new arguments -> Object >>
+=head2 C<< new (Arguments) -> Object >>
 
 Instantiates a new C<Mouse::Object>. This is obviously intended for subclasses.
 
-=head2 C<< BUILDARGS(@args) -> HashRef >>
+=head2 C<< BUILDARGS (Arguments) -> HashRef >>
 
 Lets you override the arguments that C<new> takes. Return a hashref of
 parameters.
 
-=head2 C<< BUILDALL \%args >>
+=head2 C<< BUILDALL (\%args) >>
 
 Calls C<BUILD> on each class in the class hierarchy. This is called at the
 end of C<new>.
 
-=head2 C<< BUILD \%args >>
+=head2 C<< BUILD (\%args) >>
 
 You may put any business logic initialization in BUILD methods. You don't
 need to redispatch or return any specific value.

diff --git a/lib/Squirrel.pm b/lib/Squirrel.pm
index 27579db..bbbad76 100644 (file)
--- a/lib/Squirrel.pm
+++ b/lib/Squirrel.pm
@@ -52,11 +52,11 @@ __END__
 
 =head1 NAME
 
-Squirrel - Use L<Mouse>, unless L<Moose> is already loaded. (DEPRECATED)
+Squirrel - Use Mouse, unless Moose is already loaded. (DEPRECATED)
 
 =head1 SYNOPSIS
 
-       use Squirrel;
+    use Squirrel;
 
     has goggles => (
         is => "rw", 

diff --git a/lib/Squirrel/Role.pm b/lib/Squirrel/Role.pm
index ce92b1e..86199a8 100644 (file)
--- a/lib/Squirrel/Role.pm
+++ b/lib/Squirrel/Role.pm
@@ -30,5 +30,18 @@ __END__
 
 Squirrel::Role - Use Mouse::Role, unless Moose::Role is already loaded. (DEPRECATED)
 
+=head1 SYNOPSIS
+
+    use Squirrel::Role;
+
+=head1 DEPRECATION
+
+C<Squirrel::Role> is deprecated. C<Any::Moose> provides the same functionality,
+but better. :)
+
+=head1 SEE ALSO
+
+L<Any::Moose>
+
 =cut