From 12ae21e7428e86e75aa42c1deb3204d7fe9a5bb3 Mon Sep 17 00:00:00 2001
From: Laurent Destailleur <eldy@users.sourceforge.net>
Date: Tue, 14 Sep 2004 20:53:49 +0000
Subject: [PATCH] Doc: Commentaires doxygen

---
 htdocs/paiement.class.php | 54 ++++++++++++++++++++++++++-------------
 1 file changed, 36 insertions(+), 18 deletions(-)

diff --git a/htdocs/paiement.class.php b/htdocs/paiement.class.php
index 001ae50e94c..7011209de3a 100644
--- a/htdocs/paiement.class.php
+++ b/htdocs/paiement.class.php
@@ -21,6 +21,18 @@
  *
  */
 
+/*!
+	    \file       htdocs/paiement.class.php
+        \ingroup    facture
+		\brief      Fichier de la classe des paiement de factures clients
+		\version    $Revision$
+*/
+
+
+/*! \class Paiement
+		\brief Classe permettant la gestion des paiements des factures clients
+*/
+
 class Paiement 
 {
   var $id;
@@ -35,18 +47,20 @@ class Paiement
   // fk_paiement dans llx_paiement est l'id du type de paiement (7 pour CHQ, ...)
   // fk_paiement dans llx_paiement_facture est le rowid du paiement
 
-  /*
-   *
-   *
-   *
+
+  /**
+   *    \brief  Constructeur de la classe
+   *    \param  DB          handler accès base de données
+   *    \param  soc_idp     id societe ("" par defaut)
    */
   function Paiement($DB, $soc_idp="") 
   {
     $this->db = $DB ;
   }
-  /*
-   *
-   *
+
+  /**
+   *    \brief      Recupére l'objet paiement
+   *    \param      id       id du paiement a récupérer
    */
   function fetch($id) 
     {
@@ -65,6 +79,7 @@ class Paiement
 	      $this->id             = $obj->rowid;
 	      $this->date           = $obj->dp;
 	      $this->numero         = $obj->num_paiement;
+
 	      $this->montant        = $obj->amount;
 	      $this->note           = $obj->note;
 	      $this->type_libelle   = $obj->paiement_type;
@@ -79,12 +94,14 @@ class Paiement
 	}
       else
 	{
-	  print $this->db->error();
+	  dolibarr_print_error($this->db);
 	  return 0;
 	}
     }
-  /*
-   *
+
+  /**
+   *    \brief      Création du paiement en base
+   *    \param      user       object utilisateur qui crée
    *
    */
   function create($user)
@@ -131,7 +148,7 @@ class Paiement
 			$sql .= " VALUES ('".$facid."','". $this->id."','". $amount."')";
 			if (! $this->db->query($sql) )
 			  {
-	            print dolibarr_print_error($this->db);
+	            dolibarr_print_error($this->db);
 			    $sql_err++;
 			  }
 		      }
@@ -140,7 +157,7 @@ class Paiement
 	      }
 	    else
 	      {
-	    print dolibarr_print_error($this->db);
+	    dolibarr_print_error($this->db);
 		$sql_err++;
 	      }
 	  }
@@ -158,6 +175,7 @@ class Paiement
 
       }
   }
+
   /*
    *
    *
@@ -203,13 +221,13 @@ class Paiement
       }
     else
       {
-	print $this->db->error() ."<br>".$sql;
+    dolibarr_print_error($this->db);
 	return 0;
       }    
   }
   
   /*
-   * Mise a jour du lien entre le paiement et la ligne dans llx_bank générée
+   * Mise a jour du lien entre le paiement et la ligne générée dans llx_bank
    *
    */
   function update_fk_bank($id_bank)
@@ -221,14 +239,14 @@ class Paiement
     	return 1;
         }
     else {
-	    print $this->db->error() ."<br>".$sql;
+ 	    dolibarr_print_error($this->db);
     	return 0;
         }
     }
 
   /*
-   * Information sur l'objet
-   *
+   *    \brief      Information sur l'objet
+   *    \param      id      id du paiement dont il faut afficher les infos
    */
   function info($id) 
     {
@@ -266,7 +284,7 @@ class Paiement
 	}
       else
 	{
-	  print $this->db->error();
+	  dolibarr_print_error($this->db);
 	}
     }
 }