Cleanup and add basic docs for PK::Auto::DB2

[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / PK / Auto / DB2.pm

diff --git a/lib/DBIx/Class/PK/Auto/DB2.pm b/lib/DBIx/Class/PK/Auto/DB2.pm
index a9732d5..0cfbcc1 100644 (file)
--- a/lib/DBIx/Class/PK/Auto/DB2.pm
+++ b/lib/DBIx/Class/PK/Auto/DB2.pm
@@ -22,3 +22,27 @@ sub last_insert_id
 }
 
 1;
+
+=head1 NAME 
+
+DBIx::Class::PK::Auto::DB2 - Automatic primary key class for DB2
+
+=head1 SYNOPSIS
+
+  # In your table classes
+  __PACKAGE__->load_components(qw/PK::Auto::DB2 Core/);
+  __PACKAGE__->set_primary_key('id');
+
+=head1 DESCRIPTION
+
+This class implements autoincrements for DB2.
+
+=head1 AUTHORS
+
+Jess Robinson
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
+
+=cut