lainwir3d/dolibarr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix: Bad doxygen description

Browse Source
This commit is contained in:
Laurent Destailleur 2011-08-08 16:07:47 +00:00
parent b365f7dfd2
commit 02bebbe2eb
12 changed files with 136 additions and 132 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

169
htdocs/includes/modules/dons/modules_don.php
View File

@ -20,12 +20,11 @@
*/
/**
\file htdocs/includes/modules/dons/modules_don.php
\ingroup don
\brief Fichier contenant la classe m<EFBFBD>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<EFBFBD>rotation
* \return string Texte descripif
@ -95,7 +94,7 @@ class ModeleNumRefDons
return $langs->trans("NoExample");
}
/** \brief Test si les num<EFBFBD>ros d<EFBFBD>j<EFBFBD> en vigueur dans la base ne provoquent pas de
/** \brief Test si les num<EFBFBD>ros d<EFBFBD>j<EFBFBD> en vigueur dans la base ne provoquent pas d
* de conflits qui empechera cette num<EFBFBD>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<EFBFBD>e un don sur disque en fonction du mod<EFBFBD>le de DON_ADDON_PDF
\param db objet base de donn<EFBFBD>e
\param id id du don <EFBFBD> cr<EFBFBD>er
\param message message
\param modele force le modele <EFBFBD> utiliser ('' par defaut)
\param outputlangs objet lang a utiliser pour traduction
\return int 0 si KO, 1 si OK
*/
\brief Cr<EFBFBD>e un don sur disque en fonction du mod<EFBFBD>le de DON_ADDON_PDF
\param db objet base de donn<EFBFBD>e
\param id id du don <EFBFBD> cr<EFBFBD>er
\param message message
\param modele force le modele <EFBFBD> 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 <20> 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 <20> 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<63>s de la cr<63>ation de la facture. On g<>n<EFBFBD>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<EFBFBD><EFBFBD> un meta fichier <EFBFBD> c<EFBFBD>t<EFBFBD> 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<61>e ou compliqu<71>e <20> g<>rer ... avec un rgrep c'est vite fait bien fait [eric seigne]
\param db Objet base de donn<EFBFBD>e
\param donid Id du don <EFBFBD> cr<EFBFBD>er
\param message Message
*/
\brief Cr<EFBFBD><EFBFBD> un meta fichier <EFBFBD> c<EFBFBD>t<EFBFBD> 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<61>e ou compliqu<71>e <20> g<>rer ... avec un rgrep c'est vite fait bien fait [eric seigne
\param db Objet base de donn<EFBFBD>e
\param donid Id du don <EFBFBD> cr<EFBFBD>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<EFBFBD>visualitation, pour le cas de r<EFBFBD>g<EFBFBD>n<EFBFBD>ration de facture
\param db Objet base de donn<EFBFBD>e
\param donid Id du don
*/
\brief Supprime l'image de pr<EFBFBD>visualitation, pour le cas de r<EFBFBD>g<EFBFBD>n<EFBFBD>ration de facture
\param db Objet base de donn<EFBFBD>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;

8
htdocs/includes/modules/livraison/pdf/pdf_sirocco.modules.php
View File

@ -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<EFBFBD>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);

8
htdocs/includes/modules/livraison/pdf/pdf_typhon.modules.php
View File

@ -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);

21
htdocs/lib/doxygen.php
View File

@ -18,11 +18,16 @@
*/
/**
* \mainpage Dolibarr project
*
* This is source documentation for Dolibarr ERP/CRM.<br>
* This documentation can be built or updated running the script <b>dolibarr-doxygen-build.pl</b> or from Eclipse with Doxygen plugin.<br>
* <br>
* Dolibarr official web site: <a href="http://www.dolibarr.org">www.dolibarr.org</a><br>
* Dolibarr site francophone: <a href="http://www.dolibarr.fr">www.dolibarr.fr</a><br>
*/
* \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.<br>
* This documentation can be built or updated running the script <b>dolibarr-doxygen-build.pl</b> or from Eclipse with Doxygen plugin.<br>
* <br>
* Dolibarr official web site: <a href="http://www.dolibarr.org">www.dolibarr.org</a><br>
* Dolibarr site francophone: <a href="http://www.dolibarr.fr">www.dolibarr.fr</a><br>
*/
?>

6
htdocs/product/stats/commande.php
View File

@ -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 $');
?>

6
htdocs/product/stats/commande_fournisseur.php
View File

@ -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 $');
?>

6
htdocs/product/stats/contrat.php
View File

@ -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 $');
?>

6
htdocs/product/stats/facture.php
View File

@ -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 $');
?>

6
htdocs/product/stats/facture_fournisseur.php
View File

@ -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 $');
?>

18
htdocs/product/stats/fiche.php
View File

@ -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 $');
?>

6
htdocs/product/stats/propal.php
View File

@ -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 $');
?>

8
htdocs/product/stock/product.php
View File

@ -1,6 +1,6 @@
<?php
/* Copyright (C) 2001-2007 Rodolphe Quiedeville <rodolphe@quiedeville.org>
* Copyright (C) 2004-2010 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2004-2011 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2004 Eric Seigne <eric.seigne@ryxeo.com>
* Copyright (C) 2005 Simon TOSSER <simon@kornog-computing.com>
* Copyright (C) 2005-2009 Regis Houssin <regis@dolibarr.fr>
@ -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 "</table>";
$db->close();
llxFooter('$Date: 2011/07/31 23:24:00 $ - $Revision: 1.108 $');
llxFooter('$Date: 2011/08/08 16:07:48 $ - $Revision: 1.109 $');
?>