foo

[gitmo/Moose-Autobox.git] / lib / Moose / Autobox / Indexed.pm

diff --git a/lib/Moose/Autobox/Indexed.pm b/lib/Moose/Autobox/Indexed.pm
index 3f03fec..6c3a2de 100644 (file)
--- a/lib/Moose/Autobox/Indexed.pm
+++ b/lib/Moose/Autobox/Indexed.pm
@@ -29,6 +29,39 @@ Moose::Autobox::Indexed - the Indexed role
 
 =head1 DESCRIPTION
 
+This is a role to describes an collection whose values can be 
+accessed by a key of some kind. 
+
+The role is entirely abstract, those which implement it must 
+supply all it's methods. Currently both L<Moose::Autobox::Array>
+and L<Moose::Autobox::Hash> implement this role.
+
+=head1 METHODS
+
+=over 4
+
+=item B<meta>
+
+=back
+
+=head1 REQUIRED METHODS
+
+=over 4
+
+=item B<at>
+
+=item B<put>
+
+=item B<exists>
+
+=item B<keys>
+
+=item B<values>
+
+=item B<kv>
+
+=back
+
 =head1 BUGS
 
 All complex software has bugs lurking in it, and this module is no