0.02

[gitmo/MooseX-MetaDescription.git] / lib / MooseX / MetaDescription / Meta / Attribute.pm

diff --git a/lib/MooseX/MetaDescription/Meta/Attribute.pm b/lib/MooseX/MetaDescription/Meta/Attribute.pm
index 0d645c5..a46e2dd 100644 (file)
--- a/lib/MooseX/MetaDescription/Meta/Attribute.pm
+++ b/lib/MooseX/MetaDescription/Meta/Attribute.pm
@@ -1,7 +1,7 @@
 package MooseX::MetaDescription::Meta::Attribute;
 use Moose;
 
-our $VERSION   = '0.01';
+our $VERSION   = '0.02';
 our $AUTHORITY = 'cpan:STEVAN';
 
 extends 'Moose::Meta::Attribute';
@@ -17,10 +17,45 @@ __END__
 
 MooseX::MetaDescription::Meta::Attribute - Custom attribute metaclass for meta-descriptions
 
+=head1 SYNOPSIS
+
+  package Foo;
+  use Moose;
+  
+  has 'bar' => (
+      # use the meta description attribute metaclass for this attr
+      metaclass   => 'MooseX::MetaDescription::Meta::Attribute',
+      is          => 'ro',
+      isa         => 'Str',   
+      default     => sub { 'Foo::bar' },
+      description => {
+          baz   => 'Foo::bar::baz',
+          gorch => 'Foo::bar::gorch',
+      }
+  );
+
 =head1 DESCRIPTION
 
-Nothing worth saying yet actually, mostly internal usage only. See the 
-SYNPOSIS in L<MooseX::MetaDescription> for an example of usage.
+This module provides a custom attribute metaclass to add meta 
+description capabilities to your class attributes.
+
+=head1 METHODS 
+
+NOTE: these are methods composed into this class from 
+L<MooseX::MetaDescription::Meta::Trait> refer to that 
+module for the complete description.
+
+=over 4
+
+=item B<description>
+
+=item B<metadescription_classname>
+
+=item B<metadescription>
+
+=item B<meta>
+
+=back
 
 =head1 BUGS