Renabled pod coverage test and added missing pod

[dbsrgits/DBIx-Class-UUIDColumns.git] / lib / DBIx / Class / UUIDColumns.pm

diff --git a/lib/DBIx/Class/UUIDColumns.pm b/lib/DBIx/Class/UUIDColumns.pm
index 7eca6bb..22cfc55 100644 (file)
--- a/lib/DBIx/Class/UUIDColumns.pm
+++ b/lib/DBIx/Class/UUIDColumns.pm
@@ -14,9 +14,8 @@ __PACKAGE__->uuid_class( __PACKAGE__->_find_uuid_module );
 # i.e. first release of 0.XX *must* be 0.XX000. This avoids fBSD ports
 # brain damage and presumably various other packaging systems too
 
-$VERSION = '0.06002';
+$VERSION = '0.01000';
 
-# be compatible with Class::DBI::UUID
 sub uuid_columns {
     my $self = shift;
     for (@_) {
@@ -86,14 +85,17 @@ DBIx::Class::UUIDColumns - Implicit uuid columns
 
 =head1 SYNOPSIS
 
-  package Artist;
-  __PACKAGE__->load_components(qw/UUIDColumns Core DB/);
-  __PACKAGE__->uuid_columns( 'artist_id' );
+In your L<DBIx::Class> table class:
+
+  __PACKAGE__->load_components(qw/UUIDColumns ... Core/);
+  __PACKAGE__->uuid_columns('artist_id');
+
+B<Note:> The component needs to be loaded I<before> Core.
 
 =head1 DESCRIPTION
 
-This L<DBIx::Class> component resembles the behaviour of
-L<Class::DBI::UUID>, to make some columns implicitly created as uuid.
+This L<DBIx::Class> component resembles the behaviour of L<Class::DBI::UUID>,
+to make some columns implicitly created as uuid.
 
 When loaded, C<UUIDColumns> will search for a suitable uuid generation module
 from the following list of supported modules:
@@ -109,35 +111,41 @@ If no supporting module can be found, an exception will be thrown.
 *APR::UUID will not be loaded under OpenBSD due to an as yet unidentified XS
 issue.
 
-If you would like to use a specific module, you can set C<uuid_class>:
+If you would like to use a specific module, you can set L</uuid_class>:
 
   __PACKAGE__->uuid_class('::Data::UUID');
   __PACKAGE__->uuid_class('MyUUIDGenerator');
 
-Note that the component needs to be loaded before Core.
-
 =head1 METHODS
 
-=head2 uuid_columns(@columns)
+=head2 get_uuid
+
+Returns a uuid string from the current uuid_maker.
+
+=head2 insert
+
+Inserts a new uuid string into each column in L</uuid_columns>.
+
+=head2 uuid_columns
 
 Takes a list of columns to be filled with uuids during insert.
 
-  __PACKAGE__->uuid_columns('id');
+  __PACKAGE__->uuid_columns('artist_id');
 
-=head2 uuid_class($classname)
+=head2 uuid_class
 
 Takes the name of a UUIDMaker subclass to be used for uuid value generation.
 This can be a fully qualified class name, or a shortcut name starting with ::
-that matches one of the available DBIx::Class::UUIDColumns::UUIDMaker subclasses:
+that matches one of the available L<DBIx::Class::UUIDColumns::UUIDMaker> subclasses:
 
   __PACKAGE__->uuid_class('CustomUUIDGenerator');
   # loads CustomeUUIDGenerator
 
-  __PACKAGE->uuid_class('::Data::UUID');
+  __PACKAGE__->uuid_class('::Data::UUID');
   # loads DBIx::Class::UUIDMaker::Data::UUID;
 
 Note that C<uuid_class> chacks to see that the specified class isa
-DBIx::Class::UUIDColumns::UUIDMaker subbclass and throws and exception if it isn't.
+L<DBIx::Class::UUIDColumns::UUIDMaker> subbclass and throws and exception if it isn't.
 
 =head2 uuid_maker