From: Stevan Little <stevan.little@iinteractive.com>
Date: Fri, 2 May 2008 19:41:18 +0000 (+0000)
Subject: additional docs
X-Git-Tag: 0.04~17
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=d253607a5105ff1624c0e6146184118bfc97f49a;hp=f898f6bb80bf00539dc6dcc49a1cb88fde2e2cff;p=gitmo%2FMooseX-MetaDescription.git

additional docs
---

diff --git a/lib/MooseX/MetaDescription.pm b/lib/MooseX/MetaDescription.pm
index a2b0b88..3baa9e0 100644
--- a/lib/MooseX/MetaDescription.pm
+++ b/lib/MooseX/MetaDescription.pm
@@ -38,7 +38,7 @@ MooseX::MetaDescription - A framework for adding additional metadata to Moose cl
         }
     );
 
-    ...
+    my $foo = Foo->new;
     
     $foo->meta->description; # { 'Hello' => 'World' }
     
@@ -60,14 +60,6 @@ metadata to your Moose classes and attributes. This will allow
 you to track out of band data along with attributes, which is 
 very useful for say serializing Moose classes in HTML or XML.
 
-=head1 METHODS 
-
-=over 4
-
-=item B<>
-
-=back
-
 =head1 BUGS
 
 All complex software has bugs lurking in it, and this module is no 
diff --git a/lib/MooseX/MetaDescription/Description.pm b/lib/MooseX/MetaDescription/Description.pm
index 12ece5a..5e0298b 100644
--- a/lib/MooseX/MetaDescription/Description.pm
+++ b/lib/MooseX/MetaDescription/Description.pm
@@ -19,19 +19,21 @@ __END__
 
 =head1 NAME
 
-MooseX::MetaDescription::Description - A Moosey solution to this problem
-
-=head1 SYNOPSIS
-
-  use MooseX::MetaDescription::Description;
+MooseX::MetaDescription::Description - A base class for Meta Descriptions
 
 =head1 DESCRIPTION
 
+This is a base class for building more complex custom meta-description
+classes. All it does by default is to provide a back-link to the original
+attribute it is describing.
+
 =head1 METHODS 
 
 =over 4
 
-=item B<>
+=item B<descriptor>
+
+The actual attribute that is being described.
 
 =back
 
diff --git a/lib/MooseX/MetaDescription/Meta/Attribute.pm b/lib/MooseX/MetaDescription/Meta/Attribute.pm
index fb1d4ea..0d645c5 100644
--- a/lib/MooseX/MetaDescription/Meta/Attribute.pm
+++ b/lib/MooseX/MetaDescription/Meta/Attribute.pm
@@ -15,21 +15,12 @@ __END__
 
 =head1 NAME
 
-MooseX::MetaDescription::Meta::Attribute - A Moosey solution to this problem
-
-=head1 SYNOPSIS
-
-  use MooseX::MetaDescription::Meta::Attribute;
+MooseX::MetaDescription::Meta::Attribute - Custom attribute metaclass for meta-descriptions
 
 =head1 DESCRIPTION
 
-=head1 METHODS 
-
-=over 4
-
-=item B<>
-
-=back
+Nothing worth saying yet actually, mostly internal usage only. See the 
+SYNPOSIS in L<MooseX::MetaDescription> for an example of usage.
 
 =head1 BUGS
 
diff --git a/lib/MooseX/MetaDescription/Meta/Class.pm b/lib/MooseX/MetaDescription/Meta/Class.pm
index 2a60bbd..3778917 100644
--- a/lib/MooseX/MetaDescription/Meta/Class.pm
+++ b/lib/MooseX/MetaDescription/Meta/Class.pm
@@ -15,21 +15,12 @@ __END__
 
 =head1 NAME
 
-MooseX::MetaDescription::Meta::Class - A Moosey solution to this problem
-
-=head1 SYNOPSIS
-
-  use MooseX::MetaDescription::Meta::Class;
+MooseX::MetaDescription::Meta::Class - Custom class metaclass for meta-descriptions
 
 =head1 DESCRIPTION
 
-=head1 METHODS
-
-=over 4
-
-=item B<>
-
-=back
+Nothing worth saying yet actually, mostly internal usage only. See the 
+SYNPOSIS in L<MooseX::MetaDescription> for an example of usage.
 
 =head1 BUGS
 
diff --git a/lib/MooseX/MetaDescription/Meta/Trait.pm b/lib/MooseX/MetaDescription/Meta/Trait.pm
index 2f04306..11ccb01 100644
--- a/lib/MooseX/MetaDescription/Meta/Trait.pm
+++ b/lib/MooseX/MetaDescription/Meta/Trait.pm
@@ -51,19 +51,22 @@ __END__
 
 =head1 NAME
 
-MooseX::MetaDescription::Meta::Trait - A Moosey solution to this problem
-
-=head1 SYNOPSIS
-
-  use MooseX::MetaDescription::Meta::Trait;
+MooseX::MetaDescription::Meta::Trait - Custom class meta-trait for meta-descriptions
 
 =head1 DESCRIPTION
 
+Nothing worth saying yet actually, mostly internal usage only. See the 
+SYNPOSIS in L<MooseX::MetaDescription> for an example of usage.
+
 =head1 METHODS 
 
 =over 4
 
-=item B<>
+=item B<description>
+
+=item B<metadescription_classname>
+
+=item B<metadescription>
 
 =back