From: Brian Cassidy <bricas@cpan.org>
Date: Thu, 25 Oct 2007 18:57:25 +0000 (+0000)
Subject: add docs to realm class
X-Git-Tag: v0.10009_01~40
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=85593aa9f81fe81a6a13f91d7f4d2f0476af812f;p=catagits%2FCatalyst-Plugin-Authentication.git

add docs to realm class
---

diff --git a/lib/Catalyst/Plugin/Authentication/Realm.pm b/lib/Catalyst/Plugin/Authentication/Realm.pm
index fbd7124..23c842d 100644
--- a/lib/Catalyst/Plugin/Authentication/Realm.pm
+++ b/lib/Catalyst/Plugin/Authentication/Realm.pm
@@ -150,24 +150,52 @@ Catalyst::Plugin::Authentication::Realm - Base class for realm objects.
 
 =item class
 
+By default this class is the default realm class. You can specify a custom
+realm class with this config parameter.
+
 =item auto_create_user
 
+Set this to true if you wish this realm to auto-create user accounts when the
+user doesn't exist (most useful for remote authentication schemes).
+
 =item auto_update_user
 
+Set this to true if you wish this realm to auto-update user accounts after
+authentication (most useful for remote authentication schemes).
+
 =back
 
 =head1 METHODS
 
 =head2 new( )
 
+Instantiantes this realm, plus the specified store and credential classes.
+
+=head2 store( )
+
+Holds an instance of the store object for this realm.
+
+=head2 credential( )
+
+Holds an instance of the credential object for this realm.
+
 =head2 find_user( )
 
+Delegates to the store object. Will also re-delegate auto_create_user and
+auto_update_user at this time, if necessary.
+
 =head2 authenticate( )
 
+Delegates to the credential objects and sets the authenticated user on success.
+
 =head2 save_user_in_session( )
 
+Delegates to the store object.
+
 =head2 from_session( )
 
+Delegates to the store object.
+
 =back
 
 =cut