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

diff --git a/lib/Maypole/Constants.pm b/lib/Maypole/Constants.pm
index 6917850..7e0b8ea 100644
--- a/lib/Maypole/Constants.pm
+++ b/lib/Maypole/Constants.pm
@@ -10,10 +10,30 @@ our $VERSION = "1." . sprintf "%04d", q$Rev$ =~ /: (\d+)/;
 
 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>