DomCI : Update all the PHPDoc

git-svn-id: https://svn.fournier38.fr/svn/ProgSVN/trunk@3279 bf3deb0d-5f1a-0410-827f-c0cc1f45334c

auth.php

@@ -10,10 +10,14 @@ class auth
   public $appName = null;
 
   /** Display the authentication page
-      The message is displayed to the user in case of error
-      The url is the caller url to go back if authentication is correct
-      @param string|null $message Message to display to the user
-      @param string|null $url URL to go back after successful authentication */
+    * The message is displayed to the user in case of error
+    * The url is the caller url to go back if authentication is correct
+    * @param string $baseURL The URL base to use for the links
+    * @param string|null $message Message to display to the user
+    * @param string|null $url URL to go back after successful authentication
+    * @param mixed $alreadyAuth If the user is already authenticated, the value
+    * will be displayed if the user is coming on the page.
+    */
   public function pageHTML ($baseURL, $message="", $url="", $alreadyAuth=false)
   {
     $res = "";
@@ -133,7 +137,8 @@ class auth
     return $res;
   }
 
-  /** Establish the connection to authentication server */
+  /** Establish the connection to authentication server
+    */
   public function connect ()
   {
     throw new Exception (dgettext("domframework",
@@ -142,17 +147,19 @@ class auth
   }
 
   /** Check if the email and password are correct
-      Return TRUE if the authentication is correct
-      Return an exception if there is a problem
-      @param string $email Email to authenticate
-      @param string $password Password to authenticate */
+    * Return TRUE if the authentication is correct
+    * Return an exception if there is a problem
+    * @param string $email Email to authenticate
+    * @param string $password Password to authenticate
+    */
   public function authentication ($email, $password)
   {
     throw new exception (dgettext("domframework",
                                   "No authentication available"), 405);
   }
 
-  /** Return all the parameters recorded for the authenticate user */
+  /** Return all the parameters recorded for the authenticate user
+    */
   public function getdetails ()
   {
     throw new exception (dgettext("domframework",
@@ -160,9 +167,10 @@ class auth
   }
 
   /** Method to change the password
-      @param string $oldpassword The old password (to check if the user have the
-         rights to change the password)
-      @param string $newpassword The new password to be recorded */
+    * @param string $oldpassword The old password (to check if the user have the
+    *    rights to change the password)
+    * @param string $newpassword The new password to be recorded
+    */
   public function changepassword ($oldpassword, $newpassword)
   {
     throw new exception (dgettext("domframework",
@@ -170,10 +178,11 @@ class auth
   }
 
   /** Method to overwrite the password (without oldpassword check)
-      Must be reserved to the administrators. For the users, use changepassword
-      method
-      @param string $email the user identifier to select
-      @param string $newpassword The new password to be recorded */
+    * Must be reserved to the administrators. For the users, use changepassword
+    * method
+    * @param string $email the user identifier to select
+    * @param string $newpassword The new password to be recorded
+    */
   public function overwritepassword ($email, $newpassword)
   {
     throw new exception (dgettext("domframework",
@@ -181,13 +190,16 @@ class auth
   }
 
   /** List all the users available in the database
-      Return firstname, lastname, mail, with mail is an array */
+    * Return firstname, lastname, mail, with mail is an array
+    */
   public function listusers ()
   {
     throw new exception (dgettext("domframework",
                                   "No List User available"), 405);
   }
 
+  /** Method to disconnect the authenticated user
+    */
   public function logout ()
   {
     throw new exception (dgettext("domframework",