From 66b38e06a3a4e17350efc1145c8dd6d3587db8fb Mon Sep 17 00:00:00 2001 From: Michael Joseph Date: Mon, 20 Jan 2003 08:32:26 +0000 Subject: [PATCH] updated phpdocs - @author - @package - @params --- lib/authentication/Authenticator.inc | 22 ++++++++-------------- lib/authentication/DBAuthenticator.inc | 10 ++++------ 2 files changed, 12 insertions(+), 20 deletions(-) diff --git a/lib/authentication/Authenticator.inc b/lib/authentication/Authenticator.inc index 2f0ee42..03e2658 100644 --- a/lib/authentication/Authenticator.inc +++ b/lib/authentication/Authenticator.inc @@ -1,7 +1,5 @@ owl_fs_root/lib/administration/UserManager.inc"); - /** * $Id$ * @@ -10,16 +8,16 @@ * Licensed under the GNU GPL. For full terms see the file COPYING. * * @version $Revision$ - * @author Michael Joseph, Jam Warehouse (Pty) Ltd, South Africa - * @package dmslib + * @author Michael Joseph , Jam Warehouse (Pty) Ltd, South Africa + * @package lib.authentication */ class Authenticator { /** * Verifies the login credentials * - * @param userName the user name of the user logging in - * @param password the user's password + * @param string the user name of the user logging in + * @param string the user's password * @return array containing userID and authentication status code */ function login($userName, $password) { @@ -71,10 +69,8 @@ class Authenticator { /** * Logs the user out of the application * - * @param userID - * the ID of user logging out - * @param sessionID - * the user's sessionID + * @param int the ID of user logging out + * @param string the user's sessionID */ function logout($userID, $sessionID) { // remove session from db @@ -84,10 +80,8 @@ class Authenticator { /** * [Abstract] Checks the user's password * - * @param $userName - * the name of the user to check - * @param $password - * the password to check + * @param string the name of the user to check + * @param string the password to check * @return boolean true if the password is correct, else false */ function checkPassword($userName, $password) { diff --git a/lib/authentication/DBAuthenticator.inc b/lib/authentication/DBAuthenticator.inc index 9883d3b..83be1c5 100644 --- a/lib/authentication/DBAuthenticator.inc +++ b/lib/authentication/DBAuthenticator.inc @@ -8,8 +8,8 @@ require_once("$default->owl_fs_root/lib/authentication/Authenticator.inc"); * Perform authentication tasks against the database. * * @version $Revision$ - * @author Michael Joseph, Jam Warehouse (Pty) Ltd, South Africa - * @package dmslib + * @author Michael Joseph , Jam Warehouse (Pty) Ltd, South Africa + * @package lib.authentication */ class DBAuthenticator extends Authenticator { @@ -17,10 +17,8 @@ class DBAuthenticator extends Authenticator { /** * Checks the user's password against the database * - * @param $userName - * the name of the user to check - * @param $password - * the password to check + * @param string the name of the user to check + * @param string the password to check * @return boolean true if the password is correct, else false */ function checkPassword($userName, $password) { -- libgit2 0.21.4