From 303b14c1a06e0ae86566ec172ba8c95cdf91a765 Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Sun, 15 Aug 2004 15:05:44 +0000 Subject: [PATCH] Doc: Corrections commentaires pour doc doxygen --- .../modules/facture/pdf_adytek.modules.php | 49 ++++++++++++------- .../modules/facture/pdf_bernique.modules.php | 24 ++++----- .../modules/facture/pdf_bigorneau.modules.php | 24 ++++----- .../modules/facture/pdf_bulot.modules.php | 23 +++++---- .../modules/facture/pdf_crabe.modules.php | 38 ++++++-------- .../modules/facture/pdf_tourteau.modules.php | 23 +++++---- 6 files changed, 98 insertions(+), 83 deletions(-) diff --git a/htdocs/includes/modules/facture/pdf_adytek.modules.php b/htdocs/includes/modules/facture/pdf_adytek.modules.php index 776f3d78416..afda7ad02a6 100644 --- a/htdocs/includes/modules/facture/pdf_adytek.modules.php +++ b/htdocs/includes/modules/facture/pdf_adytek.modules.php @@ -22,7 +22,19 @@ * */ -Class pdf_adytek extends FPDF{ +/*! \file htdocs/includes/modules/facture/pdf_adytek.modules.php + \ingroup facture + \brief Fichier de la classe permettant de générer les factures au modèle Adytek + \author Laurent Destailleur + \version $Revision$ +*/ + + +/*! \class pdf_adytek + \brief Classe permettant de générer les factures au modèle Adytek +*/ + +class pdf_adytek extends ModelePDFFactures { function pdf_adytek($db=0) { @@ -30,17 +42,7 @@ Class pdf_adytek extends FPDF{ $this->description = "Modèle de facture avec remise et infos réglement à la mode de chez nous"; } - - /*! - \brief Renvoi le dernier message d'erreur de création de facture - */ - function error() - { - return $this->error; - } - - - function write_pdf_file($facid) + function write_pdf_file($facid) { global $user; $fac = new Facture($this->db,"",$facid); @@ -409,11 +411,24 @@ Class pdf_adytek extends FPDF{ $tab4_hl = 6; $tab4_sl = 4; $ligne = 2; - if (defined("FAC_PDF_LOGO")) - { - $pdf->SetXY(10,5); - $pdf->Image(FAC_PDF_LOGO, 10, 5,45.0, 25.0, 'PNG'); - } + + if (defined("FAC_PDF_LOGO") && FAC_PDF_LOGO) + { + if (file_exists(FAC_PDF_LOGO)) { + $pdf->SetXY(10,5); + $pdf->Image(FAC_PDF_LOGO, 10, 5,45.0, 25.0, 'PNG'); + } + else { + $pdf->SetTextColor(200,0,0); + $pdf->SetFont('Arial','B',8); + $pdf->MultiCell(80, 3, "Logo file '".FAC_PDF_LOGO."' was not found", 0, 'L'); + $pdf->MultiCell(80, 3, "Go to setup to change path.", 0, 'L'); + } + } + else if (defined("FAC_PDF_INTITULE")) + { + $pdf->MultiCell(80, 6, FAC_PDF_INTITULE, 0, 'L'); + } $pdf->SetDrawColor(192,192,192); $pdf->line(9, 5, 200, 5 ); diff --git a/htdocs/includes/modules/facture/pdf_bernique.modules.php b/htdocs/includes/modules/facture/pdf_bernique.modules.php index 59b625f955f..74eb079642c 100644 --- a/htdocs/includes/modules/facture/pdf_bernique.modules.php +++ b/htdocs/includes/modules/facture/pdf_bernique.modules.php @@ -22,7 +22,19 @@ * */ -Class pdf_bernique { +/*! \file htdocs/includes/modules/facture/pdf_bernique.modules.php + \ingroup facture + \brief Fichier de la classe permettant de générer les factures au modèle Bernique + \author Laurent Destailleur + \version $Revision$ +*/ + + +/*! \class pdf_bernique + \brief Classe permettant de générer les factures au modèle Bernique +*/ + +class pdf_bernique extends ModelePDFFactures { function pdf_bernique($db=0) { @@ -30,16 +42,6 @@ Class pdf_bernique { $this->description = "Modèle pour les factures avec plusieurs taux de tva, inclus aussi le numéro de TVA Intracommunautaire"; } - - /*! - \brief Renvoi le dernier message d'erreur de création de facture - */ - function error() - { - return $this->error; - } - - function write_pdf_file($facid) { global $user; diff --git a/htdocs/includes/modules/facture/pdf_bigorneau.modules.php b/htdocs/includes/modules/facture/pdf_bigorneau.modules.php index b708b7a88e0..4046010b1e7 100644 --- a/htdocs/includes/modules/facture/pdf_bigorneau.modules.php +++ b/htdocs/includes/modules/facture/pdf_bigorneau.modules.php @@ -22,7 +22,19 @@ * */ -Class pdf_bigorneau { +/*! \file htdocs/includes/modules/facture/pdf_bigorneau.modules.php + \ingroup facture + \brief Fichier de la classe permettant de générer les factures au modèle Bigorneau + \author Laurent Destailleur + \version $Revision$ +*/ + + +/*! \class pdf_bigorneau + \brief Classe permettant de générer les factures au modèle Bigorneau +*/ + +class pdf_bigorneau extends ModelePDFFactures { function pdf_bigorneau($db=0) { @@ -30,16 +42,6 @@ Class pdf_bigorneau { $this->description = "Modèle de facture sans boite info réglement"; } - - /*! - \brief Renvoi le dernier message d'erreur de création de facture - */ - function error() - { - return $this->error; - } - - function write_pdf_file($facid) { global $user; diff --git a/htdocs/includes/modules/facture/pdf_bulot.modules.php b/htdocs/includes/modules/facture/pdf_bulot.modules.php index de4ec5b3d7e..d1185598c27 100644 --- a/htdocs/includes/modules/facture/pdf_bulot.modules.php +++ b/htdocs/includes/modules/facture/pdf_bulot.modules.php @@ -22,7 +22,19 @@ * */ -Class pdf_bulot { +/*! \file htdocs/includes/modules/facture/pdf_bulot.modules.php + \ingroup facture + \brief Fichier de la classe permettant de générer les factures au modèle Bulot + \author Laurent Destailleur + \version $Revision$ +*/ + + +/*! \class pdf_bulot + \brief Classe permettant de générer les factures au modèle Bulot +*/ + +class pdf_bulot extends ModelePDFFactures { function pdf_bulot($db=0) { @@ -31,15 +43,6 @@ Class pdf_bulot { } - /*! - \brief Renvoi le dernier message d'erreur de création de facture - */ - function error() - { - return $this->error; - } - - function write_pdf_file($facid) { global $user; diff --git a/htdocs/includes/modules/facture/pdf_crabe.modules.php b/htdocs/includes/modules/facture/pdf_crabe.modules.php index 28ded4dfc7e..ebbc8ebe428 100644 --- a/htdocs/includes/modules/facture/pdf_crabe.modules.php +++ b/htdocs/includes/modules/facture/pdf_crabe.modules.php @@ -21,26 +21,22 @@ * */ -/*! \file pdf_crabe.modules.php - \brief Fichier de la classe permettant de générer les factures au modèle Crabe - \author Laurent Destailleur - \version $Revision$ +/*! \file htdocs/includes/modules/facture/pdf_crabe.modules.php + \ingroup facture + \brief Fichier de la classe permettant de générer les factures au modèle Crabe + \author Laurent Destailleur + \version $Revision$ */ -require_once(DOL_DOCUMENT_ROOT."/product.class.php"); - - - /*! \class pdf_crabe \brief Classe permettant de générer les factures au modèle Crabe */ -Class pdf_crabe { - var $error=''; +class pdf_crabe extends ModelePDFFactures +{ - /*! - \brief Constructeur + /*! \brief Constructeur \param db handler accès base de donnée */ function pdf_crabe($db) @@ -56,15 +52,6 @@ Class pdf_crabe { } - /*! - \brief Renvoi le dernier message d'erreur de création de facture - */ - function error() - { - return $this->error; - } - - /*! \brief Fonction générant la facture sur le disque \param facid id de la facture à générer @@ -151,11 +138,13 @@ Class pdf_crabe { $prodser = new Product($this->db); $prodser->fetch($fac->lignes[$i]->produit_id); - $codeproduitservice=" (Code produit ".$prodser->ref.")"; + if ($prodser->ref) { + $codeproduitservice=" - Code produit ".$prodser->ref; + } } if ($fac->lignes[$i]->date_start && $fac->lignes[$i]->date_end) { // Affichage durée si il y en a une - $codeproduitservice=" (Du ".dolibarr_print_date($fac->lignes[$i]->date_start)." au ".dolibarr_print_date($fac->lignes[$i]->date_end).")"; + $codeproduitservice.=" (Du ".dolibarr_print_date($fac->lignes[$i]->date_start)." au ".dolibarr_print_date($fac->lignes[$i]->date_end).")"; } $pdf->MultiCell(118, 5, $fac->lignes[$i]->desc."$codeproduitservice", 0, 'J'); @@ -505,7 +494,8 @@ Class pdf_crabe { else { $pdf->SetTextColor(200,0,0); $pdf->SetFont('Arial','B',8); - $pdf->MultiCell(80, 6, "Logo file '".FAC_PDF_LOGO."' was not found", 0, 'L'); + $pdf->MultiCell(80, 3, "Logo file '".FAC_PDF_LOGO."' was not found", 0, 'L'); + $pdf->MultiCell(80, 3, "Go to setup to change path to logo file.", 0, 'L'); } } else if (defined("FAC_PDF_INTITULE")) diff --git a/htdocs/includes/modules/facture/pdf_tourteau.modules.php b/htdocs/includes/modules/facture/pdf_tourteau.modules.php index aebd7688af3..ca96ec2e6e6 100644 --- a/htdocs/includes/modules/facture/pdf_tourteau.modules.php +++ b/htdocs/includes/modules/facture/pdf_tourteau.modules.php @@ -22,7 +22,19 @@ * */ -Class pdf_tourteau { +/*! \file htdocs/includes/modules/facture/pdf_tourteau.modules.php + \ingroup facture + \brief Fichier de la classe permettant de générer les factures au modèle Tourteau + \author Laurent Destailleur + \version $Revision$ +*/ + + +/*! \class pdf_tourteau + \brief Classe permettant de générer les factures au modèle Tourteau +*/ + +class pdf_tourteau extends ModelePDFFactures { function pdf_tourteau($db=0) { @@ -30,15 +42,6 @@ Class pdf_tourteau { $this->description = "Modèle de facture sans remise"; } - /*! - \brief Renvoi le dernier message d'erreur de création de facture - */ - function error() - { - return $this->error; - } - - function write_pdf_file($facid) { global $user;