Doc: Ajout commentaires pour doc doxygen

This commit is contained in:
Laurent Destailleur
2004-08-15 16:38:21 +00:00
parent 49c7d2e028
commit 082460ba56
2 changed files with 118 additions and 5 deletions

View File

@@ -1,5 +1,6 @@
<?PHP
/* Copyright (C) 2003 Rodolphe Quiedeville <rodolphe@quiedeville.org>
* Copyright (C) 2004 Laurent Destailleur <eldy@users.sourceforge.net>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -21,12 +22,99 @@
*
*/
/*! \file htdocs/includes/modules/fichinter/modules_fichinter.php
\ingroup ficheinter
\brief Fichier contenant la classe m<>re de generation des fiches interventions en PDF
et la classe m<>re de num<75>rotation des fiches interventions
\version $Revision$
*/
/*! \class ModelePDFFicheinter
\brief Classe m<>re des mod<6F>les de fiche intervention
*/
class ModelePDFFicheinter extends FPDF
{
var $error='';
/*! \brief Constructeur
*/
function ModelePDFFicheinter()
{
}
/*!
\brief Renvoi le dernier message d'erreur de cr<63>ation de fiche intervention
*/
function pdferror()
{
return $this->error;
}
}
/*! \class ModeleNumRefFicheinter
\brief Classe m<>re des mod<6F>les de num<75>rotation des r<>f<EFBFBD>rences de fiches d'intervention
*/
class ModeleNumRefFicheinter
{
var $error='';
/*! \brief Constructeur
*/
function ModeleNumRefFicheinter()
{
}
/*! \brief Renvoi la description par defaut du modele de num<75>rotation
* \return string Texte descripif
*/
function getDesc()
{
global $langs;
$langs->load("ficheinter");
return $langs->trans("NoDescription");
}
/*! \brief Renvoi un exemple de num<75>rotation
* \return string Example
*/
function getExample()
{
global $langs;
$langs->load("ficheinter");
return $langs->trans("NoExample");
}
/*!
\brief Renvoi le dernier message d'erreur de cr<63>ation de fiche intervention
*/
function numreferror()
{
return $this->error;
}
}
/*!
\brief Cr<43>e une fiche intervention sur disque en fonction du mod<6F>le de FICHEINTER_ADDON_PDF
\param db objet base de donn<6E>e
\param facid id de la facture <20> cr<63>er
*/
function fichinter_pdf_create($db, $facid)
{
global $langs;
$langs->load("ficheinter");
$dir = DOL_DOCUMENT_ROOT."/includes/modules/fichinter/";
if (defined("FICHEINTER_ADDON_PDF"))
if (defined("FICHEINTER_ADDON_PDF") && FICHEINTER_ADDON_PDF)
{
$file = "pdf_".FICHEINTER_ADDON_PDF.".modules.php";
@@ -36,12 +124,20 @@ function fichinter_pdf_create($db, $facid)
$obj = new $classname($db);
return $obj->write_pdf_file($facid);
if ( $obj->write_pdf_file($facid) > 0)
{
return 1;
}
else
{
dolibarr_print_error($db,$obj->pdferror());
return 0;
}
}
else
{
print $langs->trans("Error")." ".$langs->trans("Error_FICHEINTER_ADDON_PDF_NotDefined");
return 0;
print "FICHEINTER_ADDON_PDF n'est pas d<>finit";
}
}