Doc: Ajout commentaires pour doc doxygen

htdocs/includes/modules/fichinter/modules_fichinter.php

@@ -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érotation des fiches interventions
+		\version    $Revision$
+*/
+
+
+/*!	\class ModelePDFFicheinter
+		\brief  Classe mère des modèles de fiche intervention
+*/
+
+class ModelePDFFicheinter extends FPDF
+{
+    var $error='';
+
+    /*!  \brief      Constructeur
+     */
+    function ModelePDFFicheinter()
+    {
+    
+    }
+
+   /*! 
+        \brief Renvoi le dernier message d'erreur de création de fiche intervention
+    */
+    function pdferror()
+    {
+        return $this->error;
+    }
+
+}
+
+
+/*!	\class ModeleNumRefFicheinter
+		\brief  Classe mère des modèles de numérotation des références de fiches d'intervention
+*/
+
+class ModeleNumRefFicheinter
+{
+    var $error='';
+
+    /*!     \brief      Constructeur
+     */
+    function ModeleNumRefFicheinter()
+    {
+    
+    }
+
+    /*!     \brief      Renvoi la description par defaut du modele de numérotation
+     *      \return     string      Texte descripif
+     */
+    function getDesc()
+    {
+        global $langs;
+        $langs->load("ficheinter");
+        return $langs->trans("NoDescription");
+    }
+
+    /*!     \brief      Renvoi un exemple de numérotation
+     *      \return     string      Example
+     */
+    function getExample()
+    {
+        global $langs;
+        $langs->load("ficheinter");
+        return $langs->trans("NoExample");
+    }
+
+   /*! 
+        \brief Renvoi le dernier message d'erreur de création de fiche intervention
+    */
+    function numreferror()
+    {
+        return $this->error;
+    }
+
+}
+
+
+/*!
+		\brief      Crée une fiche intervention sur disque en fonction du modèle de FICHEINTER_ADDON_PDF
+		\param	    db  		objet base de donnée
+		\param	    facid		id de la facture à cré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";
     }
 }
 

htdocs/includes/modules/fichinter/pdf_soleil.modules.php

@@ -21,16 +21,33 @@
  *
  */
 
-Class pdf_soleil
+/*!	\file htdocs/includes/modules/ficheinter/pdf_soleil.modules.php
+        \ingroup    ficheinter
+		\brief      Fichier de la classe permettant de générer les fiches d'intervention au modèle Soleil
+		\version    $Revision$
+*/
+
+
+/*!	\class pdf_soleil
+		\brief  Classe permettant de générer les fiches d'intervention au modèle Soleil
+*/
+
+class pdf_soleil extends ModelePDFFicheinter
 {
 
+    /*!		\brief  Constructeur
+    		\param	db		handler accès base de donnée
+    */
   function pdf_soleil($db=0)
     { 
       $this->db = $db;
       $this->description = "Modèle de fiche d'intervention stantdard";
     }
 
-
+    /*!
+    		\brief  Fonction générant la fiche d'intervention sur le disque
+    		\param	id		id de la fiche intervention à générer
+    */
   function write_pdf_file($id)
     {