[LON-CAPA-cvs] cvs: loncom /auth localauth.pm

[jms]

jms		Fri Nov  7 17:52:45 2008 EDT

  Modified files:              
    /loncom/auth	localauth.pm 
  Log:
  Comments updated to POD format
  
Index: loncom/auth/localauth.pm
diff -u loncom/auth/localauth.pm:1.5 loncom/auth/localauth.pm:1.6
--- loncom/auth/localauth.pm:1.5	Fri Jan 19 02:57:33 2007
+++ loncom/auth/localauth.pm	Fri Nov  7 17:52:45 2008
@@ -1,6 +1,6 @@
 # The LON-CAPA dummy localauthentication mechnism
 #
-# $Id: localauth.pm,v 1.5 2007/01/19 02:57:33 albertel Exp $
+# $Id: localauth.pm,v 1.6 2008/11/07 17:52:45 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -26,18 +26,31 @@
 #
 # 8/24 Guy Albertelli
 
+=pod
+
+=head1 NAME
+
+localauth
+
+=head1 SYNOPSIS
+
+The localauth routine receives
+ - the typed in username
+ - the typed in password
+ - the optional information that was stored when the authentication mechanism was specified 
+
+=head1 OVERVIEW
+
+It is expected to return a 1 if the user is authenticated and a 0 otherwise
+it can optionally return a negative value for an error condition. This
+negative value will get logged along with the user that caused it.
+
+=cut
+
 
 package localauth;
 
-# The localauth routine receives
-# - the typed in username
-# - the typed in password
-# - the optional information that was stored when the authentication 
-#   mechanism was specified 
-# - the domain that was typed in
-# It is expected to return a 1 if the user is authenticated and a 0 otherwise
-# it can optionally return a negative value for an error condition. This
-# negative value will get logged along with the user that caused it
+
 # ----START LOCAL CHANGES HERE ----- DON'T DELETE THIS LINE
 sub localauth {
     my ($username,$password,$optional_argument,$domain) = @_;