update pod for all modules
Dave Rolsky [Tue, 9 Feb 2010 23:21:13 +0000 (17:21 -0600)]
Changes
lib/MooseX/ClassAttribute/Meta/Role/Attribute.pm
lib/MooseX/ClassAttribute/Trait/Application.pm
lib/MooseX/ClassAttribute/Trait/Application/ToClass.pm
lib/MooseX/ClassAttribute/Trait/Application/ToInstance.pm
lib/MooseX/ClassAttribute/Trait/Application/ToRole.pm
lib/MooseX/ClassAttribute/Trait/Attribute.pm
lib/MooseX/ClassAttribute/Trait/Class.pm
lib/MooseX/ClassAttribute/Trait/Mixin/HasClassAttributes.pm
lib/MooseX/ClassAttribute/Trait/Role.pm

diff --git a/Changes b/Changes
index fe15c7a..00982ff 100644 (file)
--- a/Changes
+++ b/Changes
@@ -3,6 +3,11 @@
 - Roles can now have class attributes, which will be fully initialized when
   the role is applied to a class.
 
+- Many modules have been renamed from MooseX::ClassAttribute::Role::Meta::* to
+  MooseX::ClassAttribute::Trait::*.
+
+- Deprecated the get_class_attribute_map method.
+
 
 0.10   2009-08-26
 
index 3141ff4..746bdf4 100644 (file)
@@ -22,3 +22,33 @@ sub new {
 }
 
 1;
+
+__END__
+
+=pod
+
+=head1 NAME
+
+MooseX::ClassAttribute::Meta::Role::Attribute - An attribute metaclass for class attributes in roles
+
+=head1 DESCRIPTION
+
+This class overrides L<Moose::Meta::Role::Attribute> to support class
+attribute declaration in roles.
+
+=head1 AUTHOR
+
+Dave Rolsky, C<< <autarch@urth.org> >>
+
+=head1 BUGS
+
+See L<MooseX::ClassAttribute> for details.
+
+=head1 COPYRIGHT & LICENSE
+
+Copyright 2007-2008 Dave Rolsky, All Rights Reserved.
+
+This program is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+=cut
index 3ccf0f7..28159c1 100644 (file)
@@ -11,3 +11,33 @@ after apply_attributes => sub {
 };
 
 1;
+
+__END__
+
+=pod
+
+=head1 NAME
+
+MooseX::ClassAttribute::Trait::Application - A trait that supports role application for roles with class attributes
+
+=head1 DESCRIPTION
+
+This trait is used to allow the application of roles containing class
+attributes.
+
+=head1 AUTHOR
+
+Dave Rolsky, C<< <autarch@urth.org> >>
+
+=head1 BUGS
+
+See L<MooseX::ClassAttribute> for details.
+
+=head1 COPYRIGHT & LICENSE
+
+Copyright 2007-2008 Dave Rolsky, All Rights Reserved.
+
+This program is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+=cut
index 4232b7d..08054ea 100644 (file)
@@ -37,3 +37,33 @@ sub apply_class_attributes {
 }
 
 1;
+
+__END__
+
+=pod
+
+=head1 NAME
+
+MooseX::ClassAttribute::Trait::Application::ToClass - A trait that supports applying class attributes to classes
+
+=head1 DESCRIPTION
+
+This trait is used to allow the application of roles containing class
+attributes to classes.
+
+=head1 AUTHOR
+
+Dave Rolsky, C<< <autarch@urth.org> >>
+
+=head1 BUGS
+
+See L<MooseX::ClassAttribute> for details.
+
+=head1 COPYRIGHT & LICENSE
+
+Copyright 2007-2008 Dave Rolsky, All Rights Reserved.
+
+This program is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+=cut
index ef83c22..42f5df8 100644 (file)
@@ -41,3 +41,33 @@ sub apply_class_attributes {
 }
 
 1;
+
+__END__
+
+=pod
+
+=head1 NAME
+
+MooseX::ClassAttribute::Trait::Application::ToClass - A trait that supports applying class attributes to instances
+
+=head1 DESCRIPTION
+
+This trait is used to allow the application of roles containing class
+attributes to object instances.
+
+=head1 AUTHOR
+
+Dave Rolsky, C<< <autarch@urth.org> >>
+
+=head1 BUGS
+
+See L<MooseX::ClassAttribute> for details.
+
+=head1 COPYRIGHT & LICENSE
+
+Copyright 2007-2008 Dave Rolsky, All Rights Reserved.
+
+This program is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+=cut
index b750f42..2d2e23e 100644 (file)
@@ -51,3 +51,33 @@ sub apply_class_attributes {
 }
 
 1;
+
+__END__
+
+=pod
+
+=head1 NAME
+
+MooseX::ClassAttribute::Trait::Application::ToRole - A trait that supports applying class attributes to roles
+
+=head1 DESCRIPTION
+
+This trait is used to allow the application of roles containing class
+attributes to roles.
+
+=head1 AUTHOR
+
+Dave Rolsky, C<< <autarch@urth.org> >>
+
+=head1 BUGS
+
+See L<MooseX::ClassAttribute> for details.
+
+=head1 COPYRIGHT & LICENSE
+
+Copyright 2007-2008 Dave Rolsky, All Rights Reserved.
+
+This program is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+=cut
index a4a2b93..defc857 100644 (file)
@@ -133,7 +133,7 @@ __END__
 
 =head1 NAME
 
-MooseX::ClassAttribute::Trait::Attribute - An attribute role for classes with class attributes
+MooseX::ClassAttribute::Trait::Attribute - A trait for class attributes
 
 =head1 DESCRIPTION
 
@@ -161,5 +161,3 @@ This program is free software; you can redistribute it and/or modify
 it under the same terms as Perl itself.
 
 =cut
-
-
index 57feaaf..3f7f35f 100644 (file)
@@ -231,7 +231,7 @@ __END__
 
 =head1 NAME
 
-MooseX::ClassAttribute::Trait::Class - A metaclass role for classes with class attributes
+MooseX::ClassAttribute::Trait::Class - A trait for classes with class attributes
 
 =head1 SYNOPSIS
 
@@ -257,8 +257,6 @@ C<Class::MOP::Class> or C<Moose::Meta::Class> for regular attributes.
 
 =head2 $meta->get_class_attribute_list()
 
-=head2 $meta->get_class_attribute_map()
-
 These methods operate on the current metaclass only.
 
 =head2 $meta->add_class_attribute(...)
index ab875c2..cc0704c 100644 (file)
@@ -73,3 +73,36 @@ sub remove_class_attribute {
 }
 
 1;
+
+__END__
+
+=pod
+
+=head1 NAME
+
+MooseX::ClassAttribute::Trait::Mixin::HasClassAttributes - A mixin trait for things which have class attributes
+
+=head1 DESCRIPTION
+
+This trait is like L<Class::MOP::Mixin::HasAttributes>, except that it works
+with class attributes instead of object attributes.
+
+See L<MooseX::ClassAttribute::Trait::Class> and
+L<MooseX::ClassAttribute::Trait::Role> for API details.
+
+=head1 AUTHOR
+
+Dave Rolsky, C<< <autarch@urth.org> >>
+
+=head1 BUGS
+
+See L<MooseX::ClassAttribute> for details.
+
+=head1 COPYRIGHT & LICENSE
+
+Copyright 2007-2008 Dave Rolsky, All Rights Reserved.
+
+This program is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+=cut
index 6f86e25..a4ca238 100644 (file)
@@ -39,7 +39,7 @@ __END__
 
 =head1 NAME
 
-MooseX::ClassAttribute::Trait::Class - A metaclass role for classes with class attributes
+MooseX::ClassAttribute::Trait::Role - A trait for roles with class attributes
 
 =head1 SYNOPSIS
 
@@ -50,9 +50,9 @@ MooseX::ClassAttribute::Trait::Class - A metaclass role for classes with class a
 
 =head1 DESCRIPTION
 
-This role adds awareness of class attributes to a metaclass object. It
-provides a set of introspection methods that largely parallel the
-existing attribute methods, except they operate on class attributes.
+This role adds awareness of class attributes to a role metaclass object. It
+provides a set of introspection methods that largely parallel the existing
+attribute methods, except they operate on class attributes.
 
 =head1 METHODS
 
@@ -65,9 +65,8 @@ C<Class::MOP::Class> or C<Moose::Meta::Class> for regular attributes.
 
 =head2 $meta->get_class_attribute_list()
 
-=head2 $meta->get_class_attribute_map()
-
-These methods operate on the current metaclass only.
+These methods are exactly like their counterparts in
+L<MooseX::ClassAttribute::Trait::Class>.
 
 =head2 $meta->add_class_attribute(...)
 
@@ -77,53 +76,7 @@ C<add_attribute()> method. However, if an attribute is specified as
 
 =head2 $meta->remove_class_attribute($name)
 
-If the named class attribute exists, it is removed from the class,
-along with its accessor methods.
-
-=head2 $meta->get_all_class_attributes()
-
-This method returns a list of attribute objects for the class and all
-its parent classes.
-
-=head2 $meta->find_class_attribute_by_name($name)
-
-This method looks at the class and all its parent classes for the
-named class attribute.
-
-=head2 $meta->get_class_attribute_value($name)
-
-=head2 $meta->set_class_attribute_value($name, $value)
-
-=head2 $meta->set_class_attribute_value($name)
-
-=head2 $meta->clear_class_attribute_value($name)
-
-These methods operate on the storage for class attribute values, which
-is attached to the metaclass object.
-
-There's really no good reason for you to call these methods unless
-you're doing some deep hacking. They are named as public methods
-solely because they are used by other meta roles and classes in this
-distribution.
-
-=head2 inline_class_slot_access($name)
-
-=head2 inline_get_class_slot_value($name)
-
-=head2 inline_set_class_slot_value($name, $val_name)
-
-=head2 inline_is_class_slot_initialized($name)
-
-=head2 inline_deinitialize_class_slot($name)
-
-=head2 inline_weaken_class_slot_value($name)
-
-These methods return code snippets for inlining.
-
-There's really no good reason for you to call these methods unless
-you're doing some deep hacking. They are named as public methods
-solely because they are used by other meta roles and classes in this
-distribution.
+If the named class attribute exists, it is removed from the role.
 
 =head1 AUTHOR