From 2b0823f771278af56b88d885fb2ec70437129a46 Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Sat, 14 Aug 2004 13:27:17 +0000 Subject: [PATCH] Doc: Corrections commentaires pour doc doxygen --- htdocs/adherents/cotisation.class.php | 97 +++++++++++++-------------- htdocs/compta/bank/bank.lib.php | 15 ++--- htdocs/compta/bank/config.php | 16 +++-- 3 files changed, 67 insertions(+), 61 deletions(-) diff --git a/htdocs/adherents/cotisation.class.php b/htdocs/adherents/cotisation.class.php index 507e34c6240..5bd72d3685b 100644 --- a/htdocs/adherents/cotisation.class.php +++ b/htdocs/adherents/cotisation.class.php @@ -55,11 +55,11 @@ class Cotisation var $projet; var $errorstr; -/*! - \brief Cotisation - \param DB base de données - \param soc_idp -*/ + /*! + \brief Cotisation + \param DB base de données + \param soc_idp + */ function Cotisation($DB, $soc_idp="") { @@ -67,8 +67,8 @@ class Cotisation $this->modepaiementid = 0; } + /* - * * * */ @@ -196,9 +196,8 @@ class Cotisation } else { - print $this->db->error(); - print "


$sql

"; - return 0; + dolibarr_print_error($this->db); + return 0; } } @@ -239,16 +238,15 @@ class Cotisation } else { - print $this->db->error(); - print "


$sql

"; - return 0; + dolibarr_print_error($this->db); + return 0; } } -/*! - \brief fonction qui permet de supprimer le don - \param rowid -*/ + /*! + \brief fonction qui permet de supprimer le don + \param rowid + */ function delete($rowid) @@ -269,15 +267,15 @@ class Cotisation } else { - print "Err : ".$this->db->error(); - return 0; + dolibarr_print_error($this->db); + return 0; } } -/*! - \brief fonction qui permet de récupèrer le don - \param rowid -*/ + /*! + \brief fonction qui permet de récupèrer le don + \param rowid + */ function fetch($rowid) { @@ -320,11 +318,11 @@ class Cotisation } -/*! - \brief fonction qui permet de valider la promesse de don - \param rowid - \param userid userid de l'adhérent -*/ + /*! + \brief fonction qui permet de valider la promesse de don + \param rowid + \param userid userid de l'adhérent + */ function valid_promesse($rowid, $userid) { @@ -344,16 +342,16 @@ class Cotisation } else { - print "Err : ".$this->db->error(); - return 0; + dolibarr_print_error($this->db); + return 0; } } -/*! - \brief fonction qui permet de mettre le don comme payé - \param rowid - \param modedepaiement -*/ + /*! + \brief fonction qui permet de définir la cotisation comme payée + \param rowid rowid de la cotisation + \param modedepaiement mode de paiement + */ function set_paye($rowid, $modepaiement='') { @@ -378,16 +376,16 @@ class Cotisation } else { - print "Err : ".$this->db->error(); - return 0; + dolibarr_print_error($this->db); + return 0; } } -/*! - \brief fonction qui permet de mettre un commentaire sur le don - \param rowid - \param commentaire -*/ + /*! + \brief fonction qui permet de mettre un commentaire sur le don + \param rowid + \param commentaire + */ function set_commentaire($rowid, $commentaire='') { @@ -408,15 +406,15 @@ class Cotisation } else { - print "Err : ".$this->db->error(); - return 0; + dolibarr_print_error($this->db); + return 0; } } -/*! - \brief fonction qui permet de mettre le don comme encaissé - \param rowid -*/ + /*! + \brief fonction qui permet de mettre le don comme encaissé + \param rowid + */ function set_encaisse($rowid) { @@ -436,8 +434,8 @@ class Cotisation } else { - print "Err : ".$this->db->error(); - return 0; + dolibarr_print_error($this->db); + return 0; } } @@ -459,6 +457,7 @@ class Cotisation } } + /* Paiement recu en attente d'encaissement * * diff --git a/htdocs/compta/bank/bank.lib.php b/htdocs/compta/bank/bank.lib.php index b7a81db13ed..0106ae28855 100644 --- a/htdocs/compta/bank/bank.lib.php +++ b/htdocs/compta/bank/bank.lib.php @@ -34,14 +34,13 @@ /*! - \brief Verifie le RIB d'un compte bancaire grace à sa clé - \param code banque - \param code_guichet - \param numero_compte - \param cle - \param iban Ne sert pas pour le calcul de cle mais sert pour - determiner le pays - \return true si les infos sont bonnes, false si la clé ne correspond pas + \brief Verifie le RIB d'un compte bancaire grace à sa clé + \param code_banque code banque + \param code_guichet code guichet + \param numero_compte numero de compte + \param cle cle + \param iban Ne sert pas pour le calcul de cle mais sert pour determiner le pays + \return int true si les infos sont bonnes, false si la clé ne correspond pas */ function verif_rib($code_banque , $code_guichet , $num_compte , $cle, $iban) { diff --git a/htdocs/compta/bank/config.php b/htdocs/compta/bank/config.php index 336f5eb50f0..6b847bf34cf 100644 --- a/htdocs/compta/bank/config.php +++ b/htdocs/compta/bank/config.php @@ -19,6 +19,13 @@ * $Id$ * $Source$ */ + +/*! \file htdocs/compta/bank/config.php + \ingroup banque + \brief Page de configuration des comptes bancaires + \version $Revision$ +*/ + require("./pre.inc.php"); require("./bank.lib.php"); @@ -35,9 +42,9 @@ print '
'; print ''; print ""; -print ""; -print ""; -print ""; +print ""; +print ""; +print ""; print "\n"; $sql = "SELECT rowid, label,number,bank,clos from ".MAIN_DB_PREFIX."bank_account"; @@ -56,7 +63,8 @@ if ($result) $objp = $db->fetch_object( $i); $var=!$var; - print ""; + print ""; + print ""; $i++; }
idLabelDescriptionNumberClosidLabel".$langs->trans("Description")."".$langs->trans("Number")."Clos
$objp->rowidrowid\">$objp->label$objp->bank $objp->number ".$yn[$objp->clos]."
$objp->rowidrowid\">$objp->label$objp->bank $objp->number ".$yn[$objp->clos]."