X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=lib%2FMaypole%2FConstants.pm;h=dcf35e5b6561012e16d1911f3442d8ce284ff1a2;hb=87b344ae821415d62efc0c100836155a9e518c71;hp=a758584c1a3e0aba0bb3d58a82f35400b473f5ca;hpb=5ba93a09518403ae28e8a71b5299e2458a6dfa0b;p=maypole.git

diff --git a/lib/Maypole/Constants.pm b/lib/Maypole/Constants.pm
index a758584..dcf35e5 100644
--- a/lib/Maypole/Constants.pm
+++ b/lib/Maypole/Constants.pm
@@ -4,4 +4,52 @@ use constant OK       => 0;
 use constant DECLINED => -1;
 use constant ERROR    => -1;
 our @EXPORT = qw(OK DECLINED ERROR);
+our $VERSION = "1." . sprintf "%04d", q$Rev$ =~ /: (\d+)/;
+
 1;
+
+=head1 NAME
+
+Maypole::Constants - Maypole predefined constants
+
+=head1 SYNOPSIS
+
+    use Maypole::Constants;
+
+    sub authenticate {
+        if (valid_user()) {
+            return OK;
+        } else {
+            return DECLINED
+        }
+    }
+
+=head1 DESCRIPTION
+
+This class defines constants for use with Maypole
+
+=head2 CONSTANTS
+
+=head3 OK
+
+=head3 DECLINED
+
+=head3 ERROR
+
+=head1 SEE ALSO
+
+L<Maypole>
+
+=head1 MAINTAINER
+
+Sebastian Riedel, c<sri@oook.de>
+
+=head1 AUTHOR
+
+Simon Cozens, C<simon@cpan.org>
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
+
+=cut