[Sandweb-commit] CVS: sandweb/doc/API/Auth FlatFile.txt,1.1,1.2

[Rob H. <for...@us...>]

Update of /cvsroot/sandweb/sandweb/doc/API/Auth
In directory usw-pr-cvs1:/tmp/cvs-serv4481/Auth

Modified Files:
	FlatFile.txt 
Log Message:
done


Index: FlatFile.txt
===================================================================
RCS file: /cvsroot/sandweb/sandweb/doc/API/Auth/FlatFile.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -U2 -r1.1 -r1.2
--- FlatFile.txt	17 Oct 2002 07:30:47 -0000	1.1
+++ FlatFile.txt	19 Oct 2002 05:13:48 -0000	1.2
@@ -12,67 +12,73 @@
 SYNOPSIS
 
+	my $flatfile = SandWeb::Auth::FlatFile::->new(
+		'log_obj' => $log,
+	);
 
 DESCRIPTION
 
+	This method is a constructor.
 
 PARAMETERS
 
-    parameter (type: string) (required)
-        
+    log_obj (type: string) (required)
+
+    	A reference to an instantiated log object.    
+
         Default: none.
 
 RETURN CODES
 
-    1 = The operation completed successfully.
- 
+    Returns a reference to a FlatFile object.
+ 	 
     0 = This means that the method got an error proccessing your request.
         Perhaps an invalid parameter?
- 
-   -1 = This return value means that there was not sufficient permision to
-        read the files specified, or they did not exist.
 
-verify_password
 --------------------------------------------------------------------------------
 
 METHOD
-        methodname
 
-SYNOPSIS
+	verify_password
 
+SYNOPSIS
 
+	my $user_is_authentic = $flatfile->verify_password(
+		username => $username,
+		password => $password,
+		user_dir => $user_dir,
+		salt => $salt,
+	};
+					
 DESCRIPTION
 
+	This method verifies if a user is authentic or not by querying SandWeb's flat-file
+	database.
+
 
 PARAMETERS
 
-    parameter (type: string) (required)
+    username (type: string) (required)
+
+    	The current user's full username.
         
         Default: none.
 
-RETURN CODES
-
-    1 = The operation completed successfully.
- 
-    0 = This means that the method got an error proccessing your request.
-        Perhaps an invalid parameter?
- 
-   -1 = This return value means that there was not sufficient permision to
-        read the files specified, or they did not exist.
-
-_logobj
---------------------------------------------------------------------------------
-
-METHOD
-        methodname
+    password (type: string) (required)
 
-SYNOPSIS
+    	The encrypted password to verify.
+        
+        Default: none.
 
+    user_dir (type: string) (required)
 
-DESCRIPTION
+    	The root of where homedirs are stored.
 
+	FIXME - why does verify_password need to know this?
+        
+        Default: none.
 
-PARAMETERS
+    salt (type: string) (required)
 
-    parameter (type: string) (required)
+    	The salt used for the encrypted password.
         
         Default: none.
@@ -84,6 +90,2 @@
     0 = This means that the method got an error proccessing your request.
         Perhaps an invalid parameter?
- 
-   -1 = This return value means that there was not sufficient permision to
-        read the files specified, or they did not exist.
-