From 02bebbe2eba230f681f32400987999538fa4426b Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Mon, 8 Aug 2011 16:07:47 +0000 Subject: [PATCH] Fix: Bad doxygen description --- htdocs/includes/modules/dons/modules_don.php | 169 +++++++++--------- .../livraison/pdf/pdf_sirocco.modules.php | 8 +- .../livraison/pdf/pdf_typhon.modules.php | 8 +- htdocs/lib/doxygen.php | 21 ++- htdocs/product/stats/commande.php | 6 +- htdocs/product/stats/commande_fournisseur.php | 6 +- htdocs/product/stats/contrat.php | 6 +- htdocs/product/stats/facture.php | 6 +- htdocs/product/stats/facture_fournisseur.php | 6 +- htdocs/product/stats/fiche.php | 18 +- htdocs/product/stats/propal.php | 6 +- htdocs/product/stock/product.php | 8 +- 12 files changed, 136 insertions(+), 132 deletions(-) diff --git a/htdocs/includes/modules/dons/modules_don.php b/htdocs/includes/modules/dons/modules_don.php index 2b04f7f092d..5f9555be19c 100644 --- a/htdocs/includes/modules/dons/modules_don.php +++ b/htdocs/includes/modules/dons/modules_don.php @@ -20,12 +20,11 @@ */ /** - \file htdocs/includes/modules/dons/modules_don.php - \ingroup don - \brief Fichier contenant la classe m�re de generation des dons - \version $Id: modules_don.php,v 1.20 2011/07/31 23:28:14 eldy Exp $ -*/ - + * \file htdocs/includes/modules/dons/modules_don.php + * \ingroup don + * \brief File of class to manage donation document generation + * \version $Id: modules_don.php,v 1.21 2011/08/08 16:07:48 eldy Exp $ + */ require_once(DOL_DOCUMENT_ROOT.'/lib/pdf.lib.php'); require_once(DOL_DOCUMENT_ROOT.'/includes/fpdf/fpdfi/fpdi_protection.php'); require_once(DOL_DOCUMENT_ROOT."/compta/dons/class/don.class.php"); @@ -40,22 +39,22 @@ class ModeleDon { var $error=''; - /** - * \brief Return list of active generation modules - * \param $db Database handler - */ - function liste_modeles($db) - { - global $conf; + /** + * \brief Return list of active generation modules + * \param $db Database handler + */ + function liste_modeles($db) + { + global $conf; - $type='donation'; - $liste=array(); + $type='donation'; + $liste=array(); - include_once(DOL_DOCUMENT_ROOT.'/lib/functions2.lib.php'); - $liste=getListOfModels($db,$type,''); + include_once(DOL_DOCUMENT_ROOT.'/lib/functions2.lib.php'); + $liste=getListOfModels($db,$type,''); - return $liste; - } + return $liste; + } } @@ -67,13 +66,13 @@ class ModeleNumRefDons { var $error=''; - /** \brief Return if a module can be used or not - * \return boolean true if module can be used - */ - function isEnabled() - { - return true; - } + /** \brief Return if a module can be used or not + * \return boolean true if module can be used + */ + function isEnabled() + { + return true; + } /** \brief Renvoi la description par defaut du modele de num�rotation * \return string Texte descripif @@ -95,7 +94,7 @@ class ModeleNumRefDons return $langs->trans("NoExample"); } - /** \brief Test si les num�ros d�j� en vigueur dans la base ne provoquent pas de + /** \brief Test si les num�ros d�j� en vigueur dans la base ne provoquent pas d * de conflits qui empechera cette num�rotation de fonctionner. * \return boolean false si conflit, true si ok */ @@ -113,31 +112,31 @@ class ModeleNumRefDons return $langs->trans("NotAvailable"); } - /** \brief Renvoi version du module numerotation - * \return string Valeur - */ - function getVersion() - { - global $langs; - $langs->load("admin"); + /** \brief Renvoi version du module numerotation + * \return string Valeur + */ + function getVersion() + { + global $langs; + $langs->load("admin"); - if ($this->version == 'development') return $langs->trans("VersionDevelopment"); - if ($this->version == 'experimental') return $langs->trans("VersionExperimental"); - if ($this->version == 'dolibarr') return DOL_VERSION; - return $langs->trans("NotAvailable"); - } + if ($this->version == 'development') return $langs->trans("VersionDevelopment"); + if ($this->version == 'experimental') return $langs->trans("VersionExperimental"); + if ($this->version == 'dolibarr') return DOL_VERSION; + return $langs->trans("NotAvailable"); + } } /** - \brief Cr�e un don sur disque en fonction du mod�le de DON_ADDON_PDF - \param db objet base de donn�e - \param id id du don � cr�er - \param message message - \param modele force le modele � utiliser ('' par defaut) - \param outputlangs objet lang a utiliser pour traduction - \return int 0 si KO, 1 si OK -*/ + \brief Cr�e un don sur disque en fonction du mod�le de DON_ADDON_PDF + \param db objet base de donn�e + \param id id du don � cr�er + \param message message + \param modele force le modele � utiliser ('' par defaut) + \param outputlangs objet lang a utiliser pour traduction + \return int 0 si KO, 1 si OK + */ function don_create($db, $id, $message, $modele, $outputlangs) { global $conf, $langs; @@ -145,24 +144,24 @@ function don_create($db, $id, $message, $modele, $outputlangs) $dir = DOL_DOCUMENT_ROOT . "/includes/modules/dons/"; - // Positionne modele sur le nom du modele � utiliser - if (! dol_strlen($modele)) - { - if ($conf->global->DON_ADDON_MODEL) - { - $modele = $conf->global->DON_ADDON_MODEL; - } - else - { - print $langs->trans("Error")." ".$langs->trans("Error_DON_ADDON_MODEL_NotDefined"); - return 0; - } - } + // Positionne modele sur le nom du modele � utiliser + if (! dol_strlen($modele)) + { + if ($conf->global->DON_ADDON_MODEL) + { + $modele = $conf->global->DON_ADDON_MODEL; + } + else + { + print $langs->trans("Error")." ".$langs->trans("Error_DON_ADDON_MODEL_NotDefined"); + return 0; + } + } - // Charge le modele - $file = $modele.".modules.php"; - if (file_exists($dir.$file)) - { + // Charge le modele + $file = $modele.".modules.php"; + if (file_exists($dir.$file)) + { $classname = $modele; require_once($dir.$file); @@ -171,9 +170,9 @@ function don_create($db, $id, $message, $modele, $outputlangs) $obj->message = $message; - // We save charset_output to restore it because write_file can change it if needed for - // output format that does not support UTF8. - $sav_charset_output=$outputlangs->charset_output; + // We save charset_output to restore it because write_file can change it if needed for + // output format that does not support UTF8. + $sav_charset_output=$outputlangs->charset_output; if ($obj->write_file($id,$outputlangs) > 0) { // Succ�s de la cr�ation de la facture. On g�n�re le fichier meta @@ -181,30 +180,30 @@ function don_create($db, $id, $message, $modele, $outputlangs) // et on supprime l'image correspondant au preview don_delete_preview($db, $id); - $outputlangs->charset_output=$sav_charset_output; + $outputlangs->charset_output=$sav_charset_output; return 1; } else { - $outputlangs->charset_output=$sav_charset_output; - dol_syslog("Erreur dans don_create"); + $outputlangs->charset_output=$sav_charset_output; + dol_syslog("Erreur dans don_create"); dol_print_error($db,$obj->error); return 0; } } - else - { - print $langs->trans("Error")." ".$langs->trans("ErrorFileDoesNotExists",$dir.$file); - return 0; - } + else + { + print $langs->trans("Error")." ".$langs->trans("ErrorFileDoesNotExists",$dir.$file); + return 0; + } } /** - \brief Cr�� un meta fichier � c�t� de la facture sur le disque pour faciliter les recherches en texte plein. Pourquoi ? tout simplement parcequ'en fin d'exercice quand je suis avec mon comptable je n'ai pas de connexion internet "rapide" pour retrouver en 2 secondes une facture non pay�e ou compliqu�e � g�rer ... avec un rgrep c'est vite fait bien fait [eric seigne] - \param db Objet base de donn�e - \param donid Id du don � cr�er - \param message Message -*/ + \brief Cr�� un meta fichier � c�t� de la facture sur le disque pour faciliter les recherches en texte plein. Pourquoi ? tout simplement parcequ'en fin d'exercice quand je suis avec mon comptable je n'ai pas de connexion internet "rapide" pour retrouver en 2 secondes une facture non pay�e ou compliqu�e � g�rer ... avec un rgrep c'est vite fait bien fait [eric seigne + \param db Objet base de donn�e + \param donid Id du don � cr�er + \param message Message + */ function don_meta_create($db, $donid, $message="") { global $langs,$conf; @@ -216,13 +215,13 @@ function don_meta_create($db, $donid, $message="") /** - \brief Supprime l'image de pr�visualitation, pour le cas de r�g�n�ration de facture - \param db Objet base de donn�e - \param donid Id du don -*/ + \brief Supprime l'image de pr�visualitation, pour le cas de r�g�n�ration de facture + \param db Objet base de donn�e + \param donid Id du don + */ function don_delete_preview($db, $donid) { - global $langs,$conf; + global $langs,$conf; $don = new Don($db); $don->id=$donid; diff --git a/htdocs/includes/modules/livraison/pdf/pdf_sirocco.modules.php b/htdocs/includes/modules/livraison/pdf/pdf_sirocco.modules.php index 84ad4ed54e9..c8198051b20 100644 --- a/htdocs/includes/modules/livraison/pdf/pdf_sirocco.modules.php +++ b/htdocs/includes/modules/livraison/pdf/pdf_sirocco.modules.php @@ -22,8 +22,8 @@ /** * \file htdocs/includes/modules/livraison/pdf/pdf_sirocco.modules.php * \ingroup livraison - * \brief Fichier de la classe permettant de generer les bons de livraison au mod�le Sirocco - * \version $Id: pdf_sirocco.modules.php,v 1.77 2011/07/31 23:28:17 eldy Exp $ + * \brief File of class to manage receving receipts with template Sirocco + * \version $Id: pdf_sirocco.modules.php,v 1.78 2011/08/08 16:07:48 eldy Exp $ */ require_once(DOL_DOCUMENT_ROOT."/includes/modules/livraison/modules_livraison.php"); @@ -410,11 +410,11 @@ class pdf_sirocco extends ModelePDFDeliveryOrder if (! empty($object->linkedObjects)) { $outputlangs->load('orders'); - + foreach($object->linkedObjects as $elementtype => $objects) { $object->fetchObjectLinked('','',$objects[0]->id,$objects[0]->element); - + foreach($object->linkedObjects as $elementtype => $objects) { $num=sizeof($objects); diff --git a/htdocs/includes/modules/livraison/pdf/pdf_typhon.modules.php b/htdocs/includes/modules/livraison/pdf/pdf_typhon.modules.php index fcbf9a52cb0..dd79a49a827 100644 --- a/htdocs/includes/modules/livraison/pdf/pdf_typhon.modules.php +++ b/htdocs/includes/modules/livraison/pdf/pdf_typhon.modules.php @@ -22,9 +22,9 @@ /** * \file htdocs/includes/modules/livraison/pdf/pdf_typhon.modules.php * \ingroup livraison - * \brief Fichier de la classe permettant de generer les bons de livraison au modele Typhon + * \brief File of class to manage receving receipts with template Typhon * \author Laurent Destailleur - * \version $Id: pdf_typhon.modules.php,v 1.86 2011/07/31 23:28:17 eldy Exp $ + * \version $Id: pdf_typhon.modules.php,v 1.87 2011/08/08 16:07:48 eldy Exp $ */ require_once(DOL_DOCUMENT_ROOT."/includes/modules/livraison/modules_livraison.php"); @@ -539,11 +539,11 @@ class pdf_typhon extends ModelePDFDeliveryOrder if (! empty($object->linkedObjects)) { $outputlangs->load('orders'); - + foreach($object->linkedObjects as $elementtype => $objects) { $object->fetchObjectLinked('','',$objects[0]->id,$objects[0]->element); - + foreach($object->linkedObjects as $elementtype => $objects) { $num=sizeof($objects); diff --git a/htdocs/lib/doxygen.php b/htdocs/lib/doxygen.php index 0fefe2032fd..9b60524db98 100644 --- a/htdocs/lib/doxygen.php +++ b/htdocs/lib/doxygen.php @@ -18,11 +18,16 @@ */ /** -* \mainpage Dolibarr project -* -* This is source documentation for Dolibarr ERP/CRM.
-* This documentation can be built or updated running the script dolibarr-doxygen-build.pl or from Eclipse with Doxygen plugin.
-*
-* Dolibarr official web site: www.dolibarr.org
-* Dolibarr site francophone: www.dolibarr.fr
-*/ \ No newline at end of file + * \mainpage Dolibarr project + * \file htdocs/lib/doxygen.php + * \ingroup core + * \brief Page used as doxygen documentation header + * \version $Id: doxygen.php,v 1.7 2011/08/08 16:07:48 eldy Exp $ + * + * This is source documentation for Dolibarr ERP/CRM.
+ * This documentation can be built or updated running the script dolibarr-doxygen-build.pl or from Eclipse with Doxygen plugin.
+ *
+ * Dolibarr official web site: www.dolibarr.org
+ * Dolibarr site francophone: www.dolibarr.fr
+ */ +?> \ No newline at end of file diff --git a/htdocs/product/stats/commande.php b/htdocs/product/stats/commande.php index faace395e78..1e50dac8267 100644 --- a/htdocs/product/stats/commande.php +++ b/htdocs/product/stats/commande.php @@ -19,9 +19,9 @@ /** * \file htdocs/product/stats/commande.php - * \ingroup product, service, commande + * \ingroup product service commande * \brief Page des stats des commandes clients pour un produit - * \version $Id: commande.php,v 1.47 2011/07/31 23:24:00 eldy Exp $ + * \version $Id: commande.php,v 1.48 2011/08/08 16:07:47 eldy Exp $ */ require("../../main.inc.php"); @@ -190,5 +190,5 @@ else $db->close(); -llxFooter('$Date: 2011/07/31 23:24:00 $ - $Revision: 1.47 $'); +llxFooter('$Date: 2011/08/08 16:07:47 $ - $Revision: 1.48 $'); ?> diff --git a/htdocs/product/stats/commande_fournisseur.php b/htdocs/product/stats/commande_fournisseur.php index 1014c2e8113..0063125d4ec 100644 --- a/htdocs/product/stats/commande_fournisseur.php +++ b/htdocs/product/stats/commande_fournisseur.php @@ -19,9 +19,9 @@ /** * \file htdocs/product/stats/commande_fournisseur.php - * \ingroup product, service, commande + * \ingroup product service commande * \brief Page des stats des commandes fournisseurs pour un produit - * \version $Id: commande_fournisseur.php,v 1.33 2011/07/31 23:24:00 eldy Exp $ + * \version $Id: commande_fournisseur.php,v 1.34 2011/08/08 16:07:47 eldy Exp $ */ require("../../main.inc.php"); @@ -184,5 +184,5 @@ else $db->close(); -llxFooter('$Date: 2011/07/31 23:24:00 $ - $Revision: 1.33 $'); +llxFooter('$Date: 2011/08/08 16:07:47 $ - $Revision: 1.34 $'); ?> diff --git a/htdocs/product/stats/contrat.php b/htdocs/product/stats/contrat.php index 74c515631fa..bd8f937aa15 100644 --- a/htdocs/product/stats/contrat.php +++ b/htdocs/product/stats/contrat.php @@ -19,9 +19,9 @@ /** * \file htdocs/product/stats/contrat.php - * \ingroup product, service, contrat + * \ingroup product service contrat * \brief Page des stats des contrats pour un produit - * \version $Id: contrat.php,v 1.46 2011/07/31 23:24:00 eldy Exp $ + * \version $Id: contrat.php,v 1.47 2011/08/08 16:07:48 eldy Exp $ */ require("../../main.inc.php"); @@ -202,5 +202,5 @@ else $db->close(); -llxFooter('$Date: 2011/07/31 23:24:00 $ - $Revision: 1.46 $'); +llxFooter('$Date: 2011/08/08 16:07:48 $ - $Revision: 1.47 $'); ?> diff --git a/htdocs/product/stats/facture.php b/htdocs/product/stats/facture.php index f20df884701..86d67baa63c 100644 --- a/htdocs/product/stats/facture.php +++ b/htdocs/product/stats/facture.php @@ -19,9 +19,9 @@ /** * \file htdocs/product/stats/facture.php - * \ingroup product, service, facture + * \ingroup product service facture * \brief Page des stats des factures clients pour un produit - * \version $Id: facture.php,v 1.83 2011/07/31 23:24:00 eldy Exp $ + * \version $Id: facture.php,v 1.84 2011/08/08 16:07:47 eldy Exp $ */ require("../../main.inc.php"); @@ -193,5 +193,5 @@ else $db->close(); -llxFooter('$Date: 2011/07/31 23:24:00 $ - $Revision: 1.83 $'); +llxFooter('$Date: 2011/08/08 16:07:47 $ - $Revision: 1.84 $'); ?> \ No newline at end of file diff --git a/htdocs/product/stats/facture_fournisseur.php b/htdocs/product/stats/facture_fournisseur.php index 488cb79c16c..a80b526759b 100644 --- a/htdocs/product/stats/facture_fournisseur.php +++ b/htdocs/product/stats/facture_fournisseur.php @@ -19,9 +19,9 @@ /** * \file htdocs/product/stats/facture_fournisseur.php - * \ingroup product, service, facture + * \ingroup product service facture * \brief Page des stats des factures fournisseurs pour un produit - * \version $Id: facture_fournisseur.php,v 1.32 2011/07/31 23:24:00 eldy Exp $ + * \version $Id: facture_fournisseur.php,v 1.33 2011/08/08 16:07:47 eldy Exp $ */ require("../../main.inc.php"); @@ -194,5 +194,5 @@ else $db->close(); -llxFooter('$Date: 2011/07/31 23:24:00 $ - $Revision: 1.32 $'); +llxFooter('$Date: 2011/08/08 16:07:47 $ - $Revision: 1.33 $'); ?> diff --git a/htdocs/product/stats/fiche.php b/htdocs/product/stats/fiche.php index bd67b9e93d0..fc2e2807309 100644 --- a/htdocs/product/stats/fiche.php +++ b/htdocs/product/stats/fiche.php @@ -21,8 +21,8 @@ /** * \file htdocs/product/stats/fiche.php * \ingroup product - * \brief Page des stats produits - * \version $Id: fiche.php,v 1.110 2011/07/31 23:24:00 eldy Exp $ + * \brief Page of product statistics + * \version $Id: fiche.php,v 1.111 2011/08/08 16:07:48 eldy Exp $ */ require("../../main.inc.php"); @@ -161,7 +161,7 @@ if ($_GET["id"] || $_GET["ref"]) ); $px = new DolGraph(); - + if (! $error) { $mesg = $px->isGraphKo(); @@ -170,9 +170,9 @@ if ($_GET["id"] || $_GET["ref"]) foreach($graphfiles as $key => $val) { if (! $graphfiles[$key]['file']) continue; - + $graph_data = array(); - + // TODO Test si deja existant et recent, on ne genere pas if ($key == 'propal') $graph_data = $product->get_nb_propal($socid,$mode); if ($key == 'orders') $graph_data = $product->get_nb_order($socid,$mode); @@ -189,7 +189,7 @@ if ($_GET["id"] || $_GET["ref"]) $px->SetPrecisionY(0); $px->SetShading(3); //print 'x '.$key.' '.$graphfiles[$key]['file']; - + $px->draw($dir."/".$graphfiles[$key]['file']); } else @@ -198,10 +198,10 @@ if ($_GET["id"] || $_GET["ref"]) } } } - + $mesg = $langs->trans("ChartGenerated"); } - + // Show graphs $i=0; foreach($graphfiles as $key => $val) @@ -270,5 +270,5 @@ else $db->close(); -llxFooter('$Date: 2011/07/31 23:24:00 $ - $Revision: 1.110 $'); +llxFooter('$Date: 2011/08/08 16:07:48 $ - $Revision: 1.111 $'); ?> \ No newline at end of file diff --git a/htdocs/product/stats/propal.php b/htdocs/product/stats/propal.php index 4cf1fc9a57c..19b9d93b961 100644 --- a/htdocs/product/stats/propal.php +++ b/htdocs/product/stats/propal.php @@ -19,9 +19,9 @@ /** * \file htdocs/product/stats/propal.php - * \ingroup product, service, propal + * \ingroup product service propal * \brief Page des stats des propals pour un produit - * \version $Id: propal.php,v 1.57 2011/07/31 23:24:00 eldy Exp $ + * \version $Id: propal.php,v 1.58 2011/08/08 16:07:47 eldy Exp $ */ @@ -184,5 +184,5 @@ else $db->close(); -llxFooter('$Date: 2011/07/31 23:24:00 $ - $Revision: 1.57 $'); +llxFooter('$Date: 2011/08/08 16:07:47 $ - $Revision: 1.58 $'); ?> diff --git a/htdocs/product/stock/product.php b/htdocs/product/stock/product.php index b1c8845bb51..f4e6eea03ad 100644 --- a/htdocs/product/stock/product.php +++ b/htdocs/product/stock/product.php @@ -1,6 +1,6 @@ - * Copyright (C) 2004-2010 Laurent Destailleur + * Copyright (C) 2004-2011 Laurent Destailleur * Copyright (C) 2004 Eric Seigne * Copyright (C) 2005 Simon TOSSER * Copyright (C) 2005-2009 Regis Houssin @@ -21,9 +21,9 @@ /** * \file htdocs/product/stock/product.php - * \ingroup product, stock + * \ingroup product stock * \brief Page to list detailed stock of a product - * \version $Id: product.php,v 1.108 2011/07/31 23:24:00 eldy Exp $ + * \version $Id: product.php,v 1.109 2011/08/08 16:07:48 eldy Exp $ */ require("../../main.inc.php"); @@ -518,5 +518,5 @@ print ""; $db->close(); -llxFooter('$Date: 2011/07/31 23:24:00 $ - $Revision: 1.108 $'); +llxFooter('$Date: 2011/08/08 16:07:48 $ - $Revision: 1.109 $'); ?>