DomCI : Update all the PHPDoc

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

users.php

@@ -1,67 +1,89 @@
 <?php
 /** The abstraction class of the users
-    Allow to manage the users in multiple storages (SQL, HTPasswd, passwd file).
-    CRUD the users and allow to modify the password */
+  * Allow to manage the users in multiple storages (SQL, HTPasswd, passwd file).
+  * CRUD the users and allow to modify the password
+  */
 class users
 {
-  /** Connect to the storage */
+  /** Connect to the storage
+    */
   public function connect ()
   {
   }
 
   /** Initialise the storage
-      Create the structure of data needed to the class */
+    * Create the structure of data needed to the class
+    */
   public function initStorage ()
   {
   }
 
   /** Create a new user
-      If the password is not provided, create a default passwd (can be disable
-      password) */
+    * If the password is not provided, create a default passwd (can be disable
+    * password)
+    * @param string $email The email to create
+    * @param string $firstname The firstname to create
+    * @param string $lastname The lastname to create
+    * @param string|null $password The password of the user
+    */
   public function adduser ($email, $firstname, $lastname, $password=null)
   {
   }
 
-  /** Delete a user */
+  /** Delete a user
+    * @param string $email The email to delete
+    */
   public function deluser ($email)
   {
   }
 
-  /** Update a user */
+  /** Update a user
+    * @param string $oldemail The old email to update
+    * @param string $newemail The new mail to store
+    * @param string $firstname The new firstname to store
+    * @param string $lastname The lastname to store
+    */
   public function updateuser ($oldemail, $newemail, $firstname, $lastname)
   {
   }
 
-  /** List the users */
+  /** List the users
+    */
   public function listusers ()
   {
   }
 
   /** Change password
-      @param string $email the user email 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 $email the user email 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
+    */
   public function changepassword ($email, $oldpassword, $newpassword)
   {
   }
 
   /** Overwrite password (without oldpassword check)
-      Must be reserved to the administrators. For the users, use changepassword
-      method
-      @param string $email the user email to change the password
-      @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 email to change the password
+    * @param string $newpassword The new password to be recorded
+    */
   public function overwritepassword ($email, $newpassword)
   {
   }
 
   /** Check if the provided password is correctely associated to the email user
+    * @param string $email The email to validate
+    * @param string $password The password to validate
     */
   public function checkValidPassword ($email, $password)
   {
   }
 
-  /** Check if the user provided is correct */
+  /** Check if the user provided is correct
+    * @param string $email The email to validate
+    */
   public function checkEmail ($email)
   {
     if (! is_string ($email))
@@ -79,7 +101,9 @@ class users
     return true;
   }
 
-  /** Check if the firstname provided is correct */
+  /** Check if the firstname provided is correct
+    * @param string $firstname The firstname to check
+    */
   public function checkFirstname ($firstname)
   {
     if (! is_string ($firstname))
@@ -97,7 +121,9 @@ class users
     return true;
   }
 
-  /** Check if the lastname provided is correct */
+  /** Check if the lastname provided is correct
+    * @param string $lastname The lastname to check
+    */
   public function checkLastname ($lastname)
   {
     if (! is_string ($lastname))
@@ -111,7 +137,9 @@ class users
     return true;
   }
 
-  /** Check if the password provided is correct */
+  /** Check if the password provided is correct
+    * @param string $password The password to check
+    */
   public function checkPassword ($password)
   {
     if (! is_string ($password))
@@ -129,7 +157,9 @@ class users
     return true;
   }
 
-  /** Crypt the password with the best algorithm available */
+  /** Crypt the password with the best algorithm available
+    * @param string $password The password to crypt
+    */
   public function cryptPasswd ($password)
   {
     if (! function_exists ("openssl_random_pseudo_bytes"))
@@ -149,7 +179,9 @@ class users
   }
 
   /** Check if the password is enough complex
-      Return True if the password is enough complex */
+    * Return True if the password is enough complex
+    * @param string $password The password to check
+    */
   public function passwdComplexity ($password)
   {
   }