add docs to realm class

[catagits/Catalyst-Plugin-Authentication.git] / lib / Catalyst / Plugin / Authentication / Realm.pm

diff --git a/lib/Catalyst/Plugin/Authentication/Realm.pm b/lib/Catalyst/Plugin/Authentication/Realm.pm
index 9b162f3..23c842d 100644 (file)
--- a/lib/Catalyst/Plugin/Authentication/Realm.pm
+++ b/lib/Catalyst/Plugin/Authentication/Realm.pm
@@ -144,22 +144,59 @@ Catalyst::Plugin::Authentication::Realm - Base class for realm objects.
 
 =head1 DESCRIPTION
 
-=head1 METHODS
+=head1 CONFIGURATION
 
 =over 4
 
-=item new
+=item class
+
+By default this class is the default realm class. You can specify a custom
+realm class with this config parameter.
 
-=item find_user
+=item auto_create_user
 
-=item authenticate
+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 save_user_in_session
+=item auto_update_user
 
-=item from_session
+Set this to true if you wish this realm to auto-update user accounts after
+authentication (most useful for remote authentication schemes).
 
 =back
 
-=cut
+=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