possible 2.10 release

[maypole.git] / lib / Maypole / Session.pm

diff --git a/lib/Maypole/Session.pm b/lib/Maypole/Session.pm
index 47f68798b53fe8c415dafff18f3d9ae4e8a8dc16..b8b03dc453907ea526e2b1e491ba0abbae62e024 100644 (file)
--- a/lib/Maypole/Session.pm
+++ b/lib/Maypole/Session.pm
@@ -1,5 +1,29 @@
 package Maypole::Session;
 
+=head1 NAME
+
+Maypole::Constants - Maypole predefined constants
+
+=head1 SYNOPSIS
+
+use Maypole::Session;
+
+my $uid = Maypole::Session::generate_unique_id()
+
+=head1 DESCRIPTION
+
+This class provides session related methods for Maypole such as unique id's for requests.
+
+=head1 METHODS
+
+=head2 generate_unique_id()
+
+my $uid = Maypole::Session::generate_unique_id()
+
+generates a unique id and returns it, requires no arguments but accepts size, default is 32.
+
+=cut
+
 use strict;
 use Digest::MD5;
 
@@ -9,4 +33,28 @@ sub generate_unique_id {
     return;
 }
 
+
+###################################################################################################
+###################################################################################################
+
+
+=head1 SEE ALSO
+
+L<Maypole>
+
+=head1 MAINTAINER
+
+Aaron Trevena, c<teejay@droogs.org>
+
+=head1 AUTHOR
+
+Simon Cozens, C<simon@cpan.org>
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
+
+=cut
+
+
 1;