From: Dave Rolsky Date: Tue, 9 Feb 2010 23:21:13 +0000 (-0600) Subject: update pod for all modules X-Git-Tag: 0.11~10 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=04b89789fd31a0a17c38b3673043efd616848b8a;p=gitmo%2FMooseX-ClassAttribute.git update pod for all modules --- diff --git a/Changes b/Changes index fe15c7a..00982ff 100644 --- 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 diff --git a/lib/MooseX/ClassAttribute/Meta/Role/Attribute.pm b/lib/MooseX/ClassAttribute/Meta/Role/Attribute.pm index 3141ff4..746bdf4 100644 --- a/lib/MooseX/ClassAttribute/Meta/Role/Attribute.pm +++ b/lib/MooseX/ClassAttribute/Meta/Role/Attribute.pm @@ -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 to support class +attribute declaration in roles. + +=head1 AUTHOR + +Dave Rolsky, C<< >> + +=head1 BUGS + +See L 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 diff --git a/lib/MooseX/ClassAttribute/Trait/Application.pm b/lib/MooseX/ClassAttribute/Trait/Application.pm index 3ccf0f7..28159c1 100644 --- a/lib/MooseX/ClassAttribute/Trait/Application.pm +++ b/lib/MooseX/ClassAttribute/Trait/Application.pm @@ -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<< >> + +=head1 BUGS + +See L 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 diff --git a/lib/MooseX/ClassAttribute/Trait/Application/ToClass.pm b/lib/MooseX/ClassAttribute/Trait/Application/ToClass.pm index 4232b7d..08054ea 100644 --- a/lib/MooseX/ClassAttribute/Trait/Application/ToClass.pm +++ b/lib/MooseX/ClassAttribute/Trait/Application/ToClass.pm @@ -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<< >> + +=head1 BUGS + +See L 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 diff --git a/lib/MooseX/ClassAttribute/Trait/Application/ToInstance.pm b/lib/MooseX/ClassAttribute/Trait/Application/ToInstance.pm index ef83c22..42f5df8 100644 --- a/lib/MooseX/ClassAttribute/Trait/Application/ToInstance.pm +++ b/lib/MooseX/ClassAttribute/Trait/Application/ToInstance.pm @@ -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<< >> + +=head1 BUGS + +See L 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 diff --git a/lib/MooseX/ClassAttribute/Trait/Application/ToRole.pm b/lib/MooseX/ClassAttribute/Trait/Application/ToRole.pm index b750f42..2d2e23e 100644 --- a/lib/MooseX/ClassAttribute/Trait/Application/ToRole.pm +++ b/lib/MooseX/ClassAttribute/Trait/Application/ToRole.pm @@ -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<< >> + +=head1 BUGS + +See L 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 diff --git a/lib/MooseX/ClassAttribute/Trait/Attribute.pm b/lib/MooseX/ClassAttribute/Trait/Attribute.pm index a4a2b93..defc857 100644 --- a/lib/MooseX/ClassAttribute/Trait/Attribute.pm +++ b/lib/MooseX/ClassAttribute/Trait/Attribute.pm @@ -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 - - diff --git a/lib/MooseX/ClassAttribute/Trait/Class.pm b/lib/MooseX/ClassAttribute/Trait/Class.pm index 57feaaf..3f7f35f 100644 --- a/lib/MooseX/ClassAttribute/Trait/Class.pm +++ b/lib/MooseX/ClassAttribute/Trait/Class.pm @@ -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 or C 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(...) diff --git a/lib/MooseX/ClassAttribute/Trait/Mixin/HasClassAttributes.pm b/lib/MooseX/ClassAttribute/Trait/Mixin/HasClassAttributes.pm index ab875c2..cc0704c 100644 --- a/lib/MooseX/ClassAttribute/Trait/Mixin/HasClassAttributes.pm +++ b/lib/MooseX/ClassAttribute/Trait/Mixin/HasClassAttributes.pm @@ -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, except that it works +with class attributes instead of object attributes. + +See L and +L for API details. + +=head1 AUTHOR + +Dave Rolsky, C<< >> + +=head1 BUGS + +See L 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 diff --git a/lib/MooseX/ClassAttribute/Trait/Role.pm b/lib/MooseX/ClassAttribute/Trait/Role.pm index 6f86e25..a4ca238 100644 --- a/lib/MooseX/ClassAttribute/Trait/Role.pm +++ b/lib/MooseX/ClassAttribute/Trait/Role.pm @@ -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 or C 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. =head2 $meta->add_class_attribute(...) @@ -77,53 +76,7 @@ C 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