From f0814afe54d22ff1d235fee2b156a585df010561 Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Sun, 9 Nov 2008 12:54:44 +0000 Subject: [PATCH] doxygen --- .../pdf/ModelePdfExpedition.class.php | 8 ++--- .../modules_commandefournisseur.php | 30 +++++++++---------- htdocs/lib/doxygen.php | 2 +- htdocs/stats.class.php | 5 ++++ 4 files changed, 25 insertions(+), 20 deletions(-) diff --git a/htdocs/includes/modules/expedition/pdf/ModelePdfExpedition.class.php b/htdocs/includes/modules/expedition/pdf/ModelePdfExpedition.class.php index e97933517cb..1e055c3abef 100644 --- a/htdocs/includes/modules/expedition/pdf/ModelePdfExpedition.class.php +++ b/htdocs/includes/modules/expedition/pdf/ModelePdfExpedition.class.php @@ -20,7 +20,7 @@ */ /** - * \file htdocs/includes/module/expedition/pdf/ModelePdfExpedition.class.php + * \file htdocs/includes/modules/expedition/pdf/ModelePdfExpedition.class.php * \ingroup shipping * \brief Fichier contenant la classe mere de generation des expeditions * \version $Id$ @@ -31,9 +31,9 @@ require_once DOL_DOCUMENT_ROOT.'/includes/fpdf/DolibarrPdfBarCode.class.php'; /** - \class ModelePdfExpedition - \brief Classe m�re des mod�les de bon d'expedition -*/ + * \class ModelePdfExpedition + * \brief Parent class of ssending receipts models + */ class ModelePdfExpedition extends DolibarrPdfBarCode { diff --git a/htdocs/includes/modules/supplier_order/modules_commandefournisseur.php b/htdocs/includes/modules/supplier_order/modules_commandefournisseur.php index aaf9bbbb94a..90ccb90e4d0 100644 --- a/htdocs/includes/modules/supplier_order/modules_commandefournisseur.php +++ b/htdocs/includes/modules/supplier_order/modules_commandefournisseur.php @@ -23,16 +23,16 @@ /** * \file htdocs/includes/modules/supplier_order/modules_commandefournisseur.php * \ingroup commande - * \brief Fichier contenant la classe mère de generation des commandes fournisseurs en PDF - * et la classe mère de numérotation des commandes fournisseurs + * \brief File that contain parent class for supplier orders models + * and parent class for supplier orders numbering models * \version $Id$ */ require_once(DOL_DOCUMENT_ROOT.'/includes/fpdf/fpdfi/fpdi_protection.php'); /** - \class ModelePDFSuppliersorders - \brief Classe mère des modèles de commandes fournisseurs + * \class ModelePDFSuppliersOrders + * \brief Parent class for supplier orders models */ class ModelePDFSuppliersOrders extends FPDF @@ -40,7 +40,7 @@ class ModelePDFSuppliersOrders extends FPDF var $error=''; /** - \brief Renvoi le dernier message d'erreur de création de PDF de commande + \brief Renvoi le dernier message d'erreur de cr�ation de PDF de commande */ function pdferror() { @@ -48,7 +48,7 @@ class ModelePDFSuppliersOrders extends FPDF } /** - * \brief Renvoi la liste des modèles actifs + * \brief Renvoi la liste des mod�les actifs */ function liste_modeles($db) { @@ -84,7 +84,7 @@ class ModelePDFSuppliersOrders extends FPDF /** \class ModeleNumRefSuppliersOrders - \brief Classe mère des modèles de numérotation des références de commandes fournisseurs + \brief Classe m�re des mod�les de num�rotation des r�f�rences de commandes fournisseurs */ class ModeleNumRefSuppliersOrders @@ -99,7 +99,7 @@ class ModeleNumRefSuppliersOrders return true; } - /** \brief Renvoi la description par defaut du modele de numérotation + /** \brief Renvoi la description par defaut du modele de num�rotation * \return string Texte descripif */ function info() @@ -109,7 +109,7 @@ class ModeleNumRefSuppliersOrders return $langs->trans("NoDescription"); } - /** \brief Renvoi un exemple de numérotation + /** \brief Renvoi un exemple de num�rotation * \return string Example */ function getExample() @@ -119,8 +119,8 @@ class ModeleNumRefSuppliersOrders return $langs->trans("NoExample"); } - /** \brief Test si les numéros déjà en vigueur dans la base ne provoquent pas de - * de conflits qui empechera cette numérotation de fonctionner. + /** \brief Test si les num�ros d�j� en vigueur dans la base ne provoquent pas de + * de conflits qui empechera cette num�rotation de fonctionner. * \return boolean false si conflit, true si ok */ function canBeActivated() @@ -128,7 +128,7 @@ class ModeleNumRefSuppliersOrders return true; } - /** \brief Renvoi prochaine valeur attribuée + /** \brief Renvoi prochaine valeur attribu�e * \return string Valeur */ function getNextValue() @@ -155,9 +155,9 @@ class ModeleNumRefSuppliersOrders /** * \brief Create object on disk - * \param db objet base de donnée + * \param db objet base de donn�e * \param deliveryid id object - * \param modele force le modele à utiliser ('' to not force) + * \param modele force le modele � utiliser ('' to not force) * \param outputlangs objet lang a utiliser pour traduction * \return int 0 si KO, 1 si OK */ @@ -168,7 +168,7 @@ function supplier_order_pdf_create($db, $comid, $modele,$outputlangs) $dir = DOL_DOCUMENT_ROOT."//includes/modules/supplier_order/pdf/"; - // Positionne modele sur le nom du modele de commande fournisseur à utiliser + // Positionne modele sur le nom du modele de commande fournisseur � utiliser if (! strlen($modele)) { if (defined("COMMANDE_SUPPLIER_ADDON_PDF") && COMMANDE_SUPPLIER_ADDON_PDF) diff --git a/htdocs/lib/doxygen.php b/htdocs/lib/doxygen.php index 860ea218870..55fd3f60525 100644 --- a/htdocs/lib/doxygen.php +++ b/htdocs/lib/doxygen.php @@ -23,5 +23,5 @@ * This is source documentation for Dolibarr.
* This documentation can be built or updated running the script dolibarr-doxygen-build.pl
*
-* Dolibarr official web site: dolibarr.org
+* Dolibarr official web site: www.dolibarr.org
*/ \ No newline at end of file diff --git a/htdocs/stats.class.php b/htdocs/stats.class.php index 2b329c61ffb..f3c66afcdc4 100644 --- a/htdocs/stats.class.php +++ b/htdocs/stats.class.php @@ -23,6 +23,11 @@ * \brief Common class to manage statistics reports * \version $Id$ */ + +/** + * \class Stats + * \brief Parent class of statistics class + */ class Stats { var $db ;