Add all the phpdocs to the domframework

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

auth.php

@@ -1,10 +1,16 @@
 <?php
+/** DomFramework
+    @package domframework
+    @author Dominique Fournier <dominique@fournier38.fr> */
 
+/** User authentication (abstract class) */
 class auth
 {
   /** 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 */
+      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 */
   public function pageHTML ($message="", $url="")
   {
     $res = "";
@@ -72,7 +78,9 @@ 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 */
+      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 (_("No authentication available"), 405);
@@ -84,7 +92,10 @@ class auth
     throw new exception (_("No getdetails available"), 405);
   }
 
-  /** Method to change the password */
+  /** 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 */
   public function changepassword ($oldpassword, $newpassword)
   {
     throw new exception (_("No password change available"), 405);