X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=lib%2FMaypole%2FConstants.pm;h=dcf35e5b6561012e16d1911f3442d8ce284ff1a2;hb=889475be74f43b938d8dbcb549699c939dfe9d66;hp=69178502bbdccf7a824d103805a2cb3c0aee7275;hpb=72ebd12372713c17bb79d6510f3da7c7b4561338;p=maypole.git

diff --git a/lib/Maypole/Constants.pm b/lib/Maypole/Constants.pm
index 6917850..dcf35e5 100644
--- a/lib/Maypole/Constants.pm
+++ b/lib/Maypole/Constants.pm
@@ -6,14 +6,36 @@ 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>
@@ -31,4 +53,3 @@ Simon Cozens, C<simon@cpan.org>
 You may distribute this code under the same terms as Perl itself.
 
 =cut
-1;