X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSerialize%2FStorable.pm;h=7ccd2b0f52edb3928f3bdf5dc0da21dde115d441;hb=6e73ac255869e7fb3149915fb3fea41cc9507f43;hp=c9f1314a4bbbfc4f2a8af1e8a8a868f7e9aa1a7b;hpb=bf5ecff9ac30e6acfd912ce3c72ee86b73b775dc;p=dbsrgits%2FDBIx-Class-Historic.git

diff --git a/lib/DBIx/Class/Serialize/Storable.pm b/lib/DBIx/Class/Serialize/Storable.pm
index c9f1314..7ccd2b0 100644
--- a/lib/DBIx/Class/Serialize/Storable.pm
+++ b/lib/DBIx/Class/Serialize/Storable.pm
@@ -21,28 +21,41 @@ sub STORABLE_thaw {
 
 __END__
 
-=head1 NAME 
+=head1 NAME
 
     DBIx::Class::Serialize::Storable - hooks for Storable freeze/thaw
-    (EXPERIMENTAL)
 
 =head1 SYNOPSIS
 
     # in a table class definition
     __PACKAGE__->load_components(qw/Serialize::Storable/);
-    
+
     # meanwhile, in a nearby piece of code
     my $cd = $schema->resultset('CD')->find(12);
-    $cache->set($cd->ID, $cd); # if the cache uses Storable, this
-			       # will work automatically
+    # if the cache uses Storable, this will work automatically
+    $cache->set($cd->ID, $cd);
 
 =head1 DESCRIPTION
 
 This component adds hooks for Storable so that row objects can be
 serialized. It assumes that your row object class (C<result_class>) is
-the same as your table class, which is the normal situation. However,
-this code is not yet well tested, and so should be considered
-experimental.
+the same as your table class, which is the normal situation.
+
+=head1 HOOKS
+
+The following hooks are defined for L<Storable> - see the
+documentation for L<Storable/Hooks> for detailed information on these
+hooks.
+
+=head2 STORABLE_freeze
+
+The serializing hook, called on the object during serialization. It
+can be inherited, or defined in the class itself, like any other
+method.
+
+=head2 STORABLE_thaw
+
+The deserializing hook called on the object during deserialization.
 
 =head1 AUTHORS