POD updates: fleshed out some weak areas, reorganised a little and fixed some typogra...

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

diff --git a/lib/Maypole/Constants.pm b/lib/Maypole/Constants.pm
index b79704fbaa0d66a8e073ca63c344f97a0f471b2b..7e0b8ea3fad6789717b21cc7da77394c09d6c3b4 100644 (file)
--- a/lib/Maypole/Constants.pm
+++ b/lib/Maypole/Constants.pm
@@ -4,15 +4,36 @@ 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+)/;
 
 =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>