From 4edaf0237f6e669e8254fca3352a38b8b26abde7 Mon Sep 17 00:00:00 2001
From: Doug Bell <doug@plainblack.com>
Date: Thu, 4 Nov 2010 12:39:56 -0500
Subject: [PATCH] add more docs to Auth

---
 lib/WebGUI/Auth.pm | 23 +++++++++++++++++++----
 1 file changed, 19 insertions(+), 4 deletions(-)

diff --git a/lib/WebGUI/Auth.pm b/lib/WebGUI/Auth.pm
index f11c14135..90ac44d11 100644
--- a/lib/WebGUI/Auth.pm
+++ b/lib/WebGUI/Auth.pm
@@ -32,15 +32,30 @@ my $LOGIN_MESSAGE_SEEN  = 'showMessageOnLoginSeen';
 
 Package WebGUI::Auth
 
-=head1 DESCRIPTION
-
-An abstract class for all authentication modules to extend.
-
 =head1 SYNOPSIS
 
  package WebGUI::Auth::MyAuth;
  use base 'WebGUI::Auth';
 
+ sub www_view { 
+     # default entry point
+ }
+
+=head1 DESCRIPTION
+
+WebGUI::Auth allows you to authenticate and login users.
+
+To write your own auth module, you should override C<www_view> to start the 
+user off with a login form or a create account form.
+
+To access your new auth module, add it to the config file (authMethods) and go to 
+C<?op=auth;authType=MyAuth>. See L<WebGUI::Operation::Auth>.
+
+=head1 SEE ALSO
+
+ WebGUI::Operation::Auth
+ WebGUI::User
+
 =head1 METHODS
 
 These methods are available from this class: