Doc: Corrections commentaires pour doc doxygen

This commit is contained in:
Laurent Destailleur 2004-08-14 13:40:44 +00:00
parent 2b0823f771
commit d168febbcc
3 changed files with 29 additions and 24 deletions

View File

@ -350,7 +350,7 @@ class Cotisation
/*! /*!
\brief fonction qui permet de définir la cotisation comme payée \brief fonction qui permet de définir la cotisation comme payée
\param rowid rowid de la cotisation \param rowid rowid de la cotisation
\param modedepaiement mode de paiement \param modepaiement mode de paiement
*/ */
function set_paye($rowid, $modepaiement='') function set_paye($rowid, $modepaiement='')

View File

@ -37,7 +37,7 @@
\brief Verifie le RIB d'un compte bancaire grace à sa clé \brief Verifie le RIB d'un compte bancaire grace à sa clé
\param code_banque code banque \param code_banque code banque
\param code_guichet code guichet \param code_guichet code guichet
\param numero_compte numero de compte \param num_compte numero de compte
\param cle cle \param cle cle
\param iban Ne sert pas pour le calcul de cle mais sert pour determiner le pays \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 \return int true si les infos sont bonnes, false si la clé ne correspond pas

View File

@ -21,11 +21,13 @@
* *
*/ */
/*! \file facture.class.php /*!
\brief Fichier de la classe des factures \file htdocs/facture.class.php
\author Rodolphe Qiedeville \ingroup facture
\author Laurent Destailleur \brief Fichier de la classe des factures
\version $Revision$ \author Rodolphe Qiedeville
\author Laurent Destailleur
\version $Revision$
*/ */
@ -55,9 +57,9 @@ class Facture
/** /**
* \brief Constructeur de la classe * \brief Constructeur de la classe
* \param[in] $DB handler accès base de données * \param DB handler accès base de données
* \param[in] $soc_idp id societe ("" par defaut) * \param soc_idp id societe ("" par defaut)
* \param[in] $soc_idp id facture ("" par defaut) * \param facid id facture ("" par defaut)
*/ */
function Facture($DB, $soc_idp="", $facid="") function Facture($DB, $soc_idp="", $facid="")
{ {
@ -77,7 +79,7 @@ class Facture
/** /**
* \brief Création de la facture en base * \brief Création de la facture en base
* \param User object utilisateur qui crée * \param user object utilisateur qui crée
* *
*/ */
function create($user) function create($user)
@ -377,7 +379,7 @@ class Facture
/** /**
* \brief Supprime la facture * \brief Supprime la facture
* \param id id de la facture à supprimer * \param rowid id de la facture à supprimer
*/ */
function delete($rowid) function delete($rowid)
{ {
@ -473,6 +475,7 @@ class Facture
* \brief Tag la facture comme validée et valide la facture * \brief Tag la facture comme validée et valide la facture
* \param rowid id de la facture à modifier * \param rowid id de la facture à modifier
* \param user utilisateur qui valide la facture * \param user utilisateur qui valide la facture
* \param soc societe
*/ */
function set_valid($rowid, $user, $soc) function set_valid($rowid, $user, $soc)
{ {
@ -568,14 +571,15 @@ class Facture
/** /**
* \brief Ajoute une ligne de facture (associé à aucun produit/service prédéfini) * \brief Ajoute une ligne de facture (associé à aucun produit/service prédéfini)
* \param facid id de la facture * \param facid id de la facture
* \param desc id de la facture * \param desc description de la ligne
* \param pu id de la facture * \param pu prix unitaire
* \param qty id de la facture * \param qty quantité
* \param txtva id de la facture * \param txtva taux de tva
* \param fk_product id de la facture * \param fk_product id du produit/service predéfini
* \param date_start date_start * \param remise_percent pourcentage de remise de la ligne
* \param date_end date_end * \param datestart date de debut de validité du service
* \param dateend date de fin de validité du service
*/ */
function addline($facid, $desc, $pu, $qty, $txtva, $fk_product=0, $remise_percent=0, $datestart='', $dateend='') function addline($facid, $desc, $pu, $qty, $txtva, $fk_product=0, $remise_percent=0, $datestart='', $dateend='')
{ {
@ -673,7 +677,7 @@ class Facture
/** /**
* \brief Supprime une ligne facture de la base * \brief Supprime une ligne facture de la base
* \param id id de la ligne de facture a supprimer * \param rowid id de la ligne de facture a supprimer
*/ */
function deleteline($rowid) function deleteline($rowid)
{ {
@ -688,7 +692,7 @@ class Facture
/** /**
* \brief Mise à jour des sommes de la facture * \brief Mise à jour des sommes de la facture
* \param id id de la ligne de facture a modifier * \param facid id de la facture a modifier
*/ */
function updateprice($facid) function updateprice($facid)
{ {
@ -1020,7 +1024,7 @@ class FactureLigne
/** /**
* \brief Constructeur d'objets ligne de facture * \brief Constructeur d'objets ligne de facture
* \param db handler d'accès base de donnée * \param DB handler d'accès base de donnée
*/ */
function FactureLigne($DB) function FactureLigne($DB)
{ {
@ -1029,7 +1033,8 @@ class FactureLigne
/** /**
* \brief Recupére l'objet ligne de facture * \brief Recupére l'objet ligne de facture
* \param rowid id de la ligne de facture * \param rowid id de la ligne de facture
* \param societe_id id de la societe
*/ */
function fetch($rowid, $societe_id=0) function fetch($rowid, $societe_id=0)
{ {