Doc: Documentation doxygen

htdocs/compta/prelevement/ligne-prelevement.class.php

@@ -21,16 +21,16 @@
  */
 
 /*
-  \file       htdocs/compta/prelevement/ligne-prelevement.class.php
+        \file       htdocs/compta/prelevement/ligne-prelevement.class.php
-  \ingroup    prelevement
+        \ingroup    prelevement
-  \brief      Fichier de la classe des lignes de prelevements
+        \brief      Fichier de la classe des lignes de prelevements
-  \version    $Revision$
+        \version    $Revision$
 */
 
 
-/*!
+/**
-  \class Prelevement
+        \class      LignePrelevement
-  \brief      Classe permettant la gestion des prelevements
+        \brief      Classe permettant la gestion des prelevements
 */
 
 class LignePrelevement
@@ -40,8 +40,9 @@ class LignePrelevement
 
 
   /**
-   *    \brief  Constructeur de la classe
+   *    \brief      Constructeur de la classe
-   *    \param  DB          handler accès base de données
+   *    \param      DB          Handler accès base de données
+   *    \param      user        Objet user
    */
   function LignePrelevement($DB, $user)
   {
@@ -57,7 +58,6 @@ class LignePrelevement
   /**
    *    \brief      Recupére l'objet prelevement
    *    \param      rowid       id de la facture a récupérer
-   *    \param      societe_id  id de societe
    */
   function fetch($rowid)
   {

htdocs/includes/modules/societe/mod_codecompta_aquarium.php

@@ -37,10 +37,10 @@ class mod_codecompta_aquarium
   }
 
   /**
-   * \param societe objet societe
+   *    \brief      Renvoi code
-   *
+   *    \param      DB              Handler d'accès base
+   *    \param      societe         Objet societe
    */
-
   function get_code($DB, $societe)
   {    
     $i = 0;

htdocs/includes/modules/societe/mod_codecompta_digitaria.php

@@ -35,10 +35,10 @@ class mod_codecompta_digitaria
   }
 
   /**
-   * \param societe objet societe
+   *    \brief      Renvoi code
-   *
+   *    \param      DB              Handler d'accès base
+   *    \param      societe         Objet societe
    */
-
   function get_code($DB, $societe)
   {    
     $i = 0;

htdocs/includes/modules/societe/mod_codecompta_panicum.php

@@ -34,7 +34,12 @@ class mod_codecompta_panicum
     return "Renvoie un code compta identique à celui saisi. Module dédié aux tests";
   }
   
-  function get_code($db, $societe)
+  /**
+   *    \brief      Renvoi code
+   *    \param      DB              Handler d'accès base
+   *    \param      societe         Objet societe
+   */
+  function get_code($DB, $societe)
   {
     // Renvoie toujours ok
     $this->code = $societe->code_compta;

htdocs/user/modules/login.anakin.class.php

@@ -24,33 +24,28 @@
  */
 
 /**
-	    \file       htdocs/user.class.php
+	    \file       htdocs/user/modules/login.anakin.class.php
-  	    \brief      Fichier de la classe utilisateur
+  	    \brief      Fichier de la classe de génération de login anakin
   	    \author     Rodolphe Qiedeville
-  	    \author     Jean-Louis Bergamo
-  	    \author     Laurent Destailleur
-  	    \author     Sebastien Di Cintio
-  	    \author     Benoit Mortier
   	    \version    $Revision$
 */
 
 
-
 /**
-        \class      User
+        \class      LoginAnakin
-		\brief      Classe permettant la gestion d'un utilisateur
+		\brief      Classe permettant la génération de login anakin
 */
 
 class LoginAnakin
 {
   var $db;
+  var $user;
 
   /**
-   *    \brief Constructeur de la classe
+   *    \brief      Constructeur de la classe
-   *    \param  $DB         handler accès base de données
+   *    \param      $DB         Handler accès base de données
-   *    \param  $id         id de l'utilisateur (0 par défaut)
+   *    \param      $user       Objet de l'utilisateur
    */
-	 
   function LoginAnakin($DB, $user)
     {
       $this->db = $DB;
@@ -59,6 +54,7 @@ class LoginAnakin
       return 0;
   }
 
+
   function generate_login()
   {
     $ok = 0;
@@ -91,7 +87,6 @@ class LoginAnakin
    *    \brief      Vérifie la disponibilité du login
    *    \return     1 si le login n'existe pas dans la base, 1 sinon
    */
-
   function dispo()
   {
     $sql = "SELECT login FROM ".MAIN_DB_PREFIX."user WHERE login ='".$this->login."';";
@@ -114,9 +109,9 @@ class LoginAnakin
 
   }
 
+
   // Règle primaire
   // 8 premières lettre désaccentuées du nom en minuscule
-
   function generate_login_1()
   {
     $nom = unaccent(strtolower($this->user->nom));
@@ -124,8 +119,8 @@ class LoginAnakin
     $this->login = substr($nom, 0, 8);
   }
 
-  // Règle de défaut
 
+  // Règle de défaut
   function generate_login_else()
   {
     $login = unaccent(strtolower($this->user->nom));
@@ -135,9 +130,9 @@ class LoginAnakin
     $this->login = substr($login, 0, (8-$le)) . $this->else_step;
   }
 
+
   // Règles annexes
   // première lettre du prénom + 7 premières lettres du nom, désaccentuées en minuscule
-
   function generate_login_2()
   {
     $nom = unaccent(strtolower($this->user->nom));
@@ -146,8 +141,8 @@ class LoginAnakin
     $this->login = substr($prenom, 0, 1) . substr($nom, 0, 7);
   }
 
-  // 2 premières lettres du prénom + 6 premières lettres du nom, désaccentuées en minuscule
 
+  // 2 premières lettres du prénom + 6 premières lettres du nom, désaccentuées en minuscule
   function generate_login_3()
   {
     $nom = unaccent(strtolower($this->user->nom));
@@ -156,6 +151,5 @@ class LoginAnakin
     $this->login = substr($prenom, 0, 2) . substr($nom, 0, 6);
   }
 
-
 }
 ?>