X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=lib%2FMaypole%2FConstants.pm;h=7e0b8ea3fad6789717b21cc7da77394c09d6c3b4;hb=b6e2413ee413ce21b28429c05bbcc3f516a0754a;hp=7bddbacfaa709af2c869ffa6536a1d0c5e5d39be;hpb=0f0ccfbbe2488b34841e5af2ecedd9f256c8489f;p=maypole.git

diff --git a/lib/Maypole/Constants.pm b/lib/Maypole/Constants.pm
index 7bddbac..7e0b8ea 100644
--- a/lib/Maypole/Constants.pm
+++ b/lib/Maypole/Constants.pm
@@ -1,7 +1,54 @@
 package Maypole::Constants;
 use base 'Exporter';
-use constant OK => 0;
+use constant OK       => 0;
 use constant DECLINED => -1;
-use constant ERROR => -1;
+use constant ERROR    => -1;
 our @EXPORT = qw(OK DECLINED ERROR);
+our $VERSION = "1." . sprintf "%04d", q$Rev$ =~ /: (\d+)/;
+
+=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
+
+=head1 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
 1;