From 051f4e2983ccb91d217aa0e3bfb14deb41087349 Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Wed, 29 Jul 2009 22:52:08 +0000 Subject: [PATCH] Doxygen --- .../includes/modules/modAccounting.class.php | 2 +- htdocs/includes/modules/modAdherent.class.php | 2 +- htdocs/includes/modules/modBanque.class.php | 12 +++---- htdocs/includes/modules/modBarcode.class.php | 2 +- htdocs/includes/modules/modBookmark.class.php | 2 +- htdocs/includes/modules/modBoutique.class.php | 2 +- htdocs/includes/modules/modCashDesk.class.php | 14 ++++---- .../includes/modules/modCategorie.class.php | 2 +- .../includes/modules/modClickToDial.class.php | 12 +++---- htdocs/includes/modules/modCommande.class.php | 12 +++---- htdocs/includes/modules/modContrat.class.php | 12 +++---- .../includes/modules/modDeplacement.class.php | 2 +- htdocs/includes/modules/modDocument.class.php | 2 +- htdocs/includes/modules/modDon.class.php | 2 +- .../includes/modules/modDroitPret.class.php | 2 +- htdocs/includes/modules/modECM.class.php | 2 +- htdocs/includes/modules/modEditeur.class.php | 2 +- htdocs/includes/modules/modEnergie.class.php | 2 +- .../includes/modules/modExpedition.class.php | 2 +- htdocs/includes/modules/modFacture.class.php | 2 +- .../includes/modules/modFournisseur.class.php | 2 +- htdocs/includes/modules/modGravatar.class.php | 2 +- htdocs/includes/modules/modImport.class.php | 2 +- htdocs/includes/modules/modLabel.class.php | 12 +++---- htdocs/includes/modules/modMailing.class.php | 4 +-- htdocs/includes/modules/modMantis.class.php | 2 +- .../modules/modMultiCompany.class.php | 5 ++- .../modules/modNotification.class.php | 4 +-- .../modules/modOSCommerceWS.class.php | 2 +- htdocs/includes/modules/modPaybox.class.php | 5 ++- htdocs/includes/modules/modPhenix.class.php | 32 ++++++++--------- htdocs/includes/modules/modProduit.class.php | 2 +- htdocs/includes/modules/modPropale.class.php | 2 +- htdocs/includes/modules/modService.class.php | 2 +- htdocs/includes/modules/modStock.class.php | 2 +- htdocs/includes/modules/modUser.class.php | 2 +- .../includes/modules/modWebServices.class.php | 2 +- .../includes/modules/modWebcalendar.class.php | 34 +++++++++---------- 38 files changed, 104 insertions(+), 106 deletions(-) diff --git a/htdocs/includes/modules/modAccounting.class.php b/htdocs/includes/modules/modAccounting.class.php index 171b3457759..6c0a6844152 100644 --- a/htdocs/includes/modules/modAccounting.class.php +++ b/htdocs/includes/modules/modAccounting.class.php @@ -20,7 +20,7 @@ */ /** \defgroup accounting Module accounting - * \brief Module pour inclure des fonctions de comptabilite (gestion de comptes comptables et rapports) + * \brief Module to include accounting features * \version $Id$ */ diff --git a/htdocs/includes/modules/modAdherent.class.php b/htdocs/includes/modules/modAdherent.class.php index 5ddbdc00473..e0aa1ea3ff7 100644 --- a/htdocs/includes/modules/modAdherent.class.php +++ b/htdocs/includes/modules/modAdherent.class.php @@ -21,7 +21,7 @@ */ /** - * \defgroup adherent Module adherents + * \defgroup adherent Module foundation * \brief Module pour gerer les adherents d'une association */ diff --git a/htdocs/includes/modules/modBanque.class.php b/htdocs/includes/modules/modBanque.class.php index 3d5a16a0402..0d6582371c7 100644 --- a/htdocs/includes/modules/modBanque.class.php +++ b/htdocs/includes/modules/modBanque.class.php @@ -20,15 +20,15 @@ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ -/** \defgroup banque Module banque - \brief Module pour gérer la tenue d'un compte bancaire et rapprochements - \version $Id$ +/** \defgroup banque Module bank + * \brief Module pour gérer la tenue d'un compte bancaire et rapprochements + * \version $Id$ */ /** - \file htdocs/includes/modules/modBanque.class.php - \ingroup banque - \brief Fichier de description et activation du module Banque + * \file htdocs/includes/modules/modBanque.class.php + * \ingroup banque + * \brief Fichier de description et activation du module Banque */ include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php"); diff --git a/htdocs/includes/modules/modBarcode.class.php b/htdocs/includes/modules/modBarcode.class.php index f1aa21741f4..3fc751ce934 100644 --- a/htdocs/includes/modules/modBarcode.class.php +++ b/htdocs/includes/modules/modBarcode.class.php @@ -19,7 +19,7 @@ */ /** - * \defgroup barcode Module code barre + * \defgroup barcode Module barcode * \brief Module pour gerer les codes barres * \version $Id$ */ diff --git a/htdocs/includes/modules/modBookmark.class.php b/htdocs/includes/modules/modBookmark.class.php index d2657d62156..965f4dfe27c 100644 --- a/htdocs/includes/modules/modBookmark.class.php +++ b/htdocs/includes/modules/modBookmark.class.php @@ -18,7 +18,7 @@ */ /** - * \defgroup bookmark Module Bookmark + * \defgroup bookmark Module bookmarks * \brief Module to manage Bookmarks * \version $Id$ */ diff --git a/htdocs/includes/modules/modBoutique.class.php b/htdocs/includes/modules/modBoutique.class.php index e72f6b71989..693370f31d8 100644 --- a/htdocs/includes/modules/modBoutique.class.php +++ b/htdocs/includes/modules/modBoutique.class.php @@ -19,7 +19,7 @@ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ -/** \defgroup oscommerce Module OSCommerce +/** \defgroup oscommerce Module oscommerce \brief Module pour gerer une boutique et interface avec OSCommerce \version $Id$ */ diff --git a/htdocs/includes/modules/modCashDesk.class.php b/htdocs/includes/modules/modCashDesk.class.php index e50ef573bce..8dfa6b470d1 100644 --- a/htdocs/includes/modules/modCashDesk.class.php +++ b/htdocs/includes/modules/modCashDesk.class.php @@ -17,16 +17,16 @@ */ /** - \defgroup category Module categorie - \brief Module pour gérer les catégories - \version $Id$ + * \defgroup pos Module points of sale + * \brief Module to manage points of sale + * \version $Id$ */ /** - \file htdocs/includes/modules/modCashDesk.class.php - \ingroup category - \brief File to enable/disable module CashDesk -*/ + * \file htdocs/includes/modules/modCashDesk.class.php + * \ingroup pos + * \brief File to enable/disable module CashDesk + */ include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php"); diff --git a/htdocs/includes/modules/modCategorie.class.php b/htdocs/includes/modules/modCategorie.class.php index e28d1b278c2..9b1432eb06a 100644 --- a/htdocs/includes/modules/modCategorie.class.php +++ b/htdocs/includes/modules/modCategorie.class.php @@ -18,7 +18,7 @@ */ /** - \defgroup category Module categorie + \defgroup category Module categories \brief Module pour gérer les catégories \version $Id$ */ diff --git a/htdocs/includes/modules/modClickToDial.class.php b/htdocs/includes/modules/modClickToDial.class.php index 09086bf91da..0c43f97a1da 100644 --- a/htdocs/includes/modules/modClickToDial.class.php +++ b/htdocs/includes/modules/modClickToDial.class.php @@ -18,15 +18,15 @@ */ /** - \defgroup clicktodial Module click to dial - \brief Module pour g�rer l'appel automatique + * \defgroup clicktodial Module clicktodial + * \brief Module pour gerer l'appel automatique */ /** - \file htdocs/includes/modules/modClickToDial.class.php - \ingroup clicktodial - \brief Fichier de description et activation du module de click to Dial - \version $Id$ + * \file htdocs/includes/modules/modClickToDial.class.php + * \ingroup clicktodial + * \brief Fichier de description et activation du module de click to Dial + * \version $Id$ */ include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php"); diff --git a/htdocs/includes/modules/modCommande.class.php b/htdocs/includes/modules/modCommande.class.php index 37cb9bd4f68..78b4fe59e81 100644 --- a/htdocs/includes/modules/modCommande.class.php +++ b/htdocs/includes/modules/modCommande.class.php @@ -21,15 +21,15 @@ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ -/** \defgroup commande Module commande - \brief Module pour gerer le suivi des commandes - \version $Id$ +/** \defgroup commande Module orders + * \brief Module pour gerer le suivi des commandes + * \version $Id$ */ /** - \file htdocs/includes/modules/modCommande.class.php - \ingroup commande - \brief Fichier de description et activation du module Commande + * \file htdocs/includes/modules/modCommande.class.php + * \ingroup commande + * \brief Fichier de description et activation du module Commande */ include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php"); diff --git a/htdocs/includes/modules/modContrat.class.php b/htdocs/includes/modules/modContrat.class.php index 2baf57f5995..8bdc109a2cc 100644 --- a/htdocs/includes/modules/modContrat.class.php +++ b/htdocs/includes/modules/modContrat.class.php @@ -18,15 +18,15 @@ */ /** - \defgroup contrat Module contrat - \brief Module pour gerer la tenue de contrat de services - \version $Id$ + * \defgroup contrat Module contract + * \brief Module pour gerer la tenue de contrat de services + * \version $Id$ */ /** - \file htdocs/includes/modules/modContrat.class.php - \ingroup contrat - \brief Fichier de description et activation du module Contrat + * \file htdocs/includes/modules/modContrat.class.php + * \ingroup contrat + * \brief Fichier de description et activation du module Contrat */ include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php"); diff --git a/htdocs/includes/modules/modDeplacement.class.php b/htdocs/includes/modules/modDeplacement.class.php index bac97c47cdf..8071e0ff030 100644 --- a/htdocs/includes/modules/modDeplacement.class.php +++ b/htdocs/includes/modules/modDeplacement.class.php @@ -18,7 +18,7 @@ */ /** - \defgroup deplacement Module deplacement et notes de frais + \defgroup deplacement Module trips \brief Module pour gerer les deplacements et notes de frais \version $Id$ */ diff --git a/htdocs/includes/modules/modDocument.class.php b/htdocs/includes/modules/modDocument.class.php index 7c075bd6524..4b08913ee90 100644 --- a/htdocs/includes/modules/modDocument.class.php +++ b/htdocs/includes/modules/modDocument.class.php @@ -18,7 +18,7 @@ */ /** - * \defgroup document Module de generation de documents + * \defgroup document Module mass mailings * \brief Module pour gerer des generations de documents * \version $Id$ */ diff --git a/htdocs/includes/modules/modDon.class.php b/htdocs/includes/modules/modDon.class.php index bdb50a6935c..f218be926b8 100644 --- a/htdocs/includes/modules/modDon.class.php +++ b/htdocs/includes/modules/modDon.class.php @@ -19,7 +19,7 @@ */ /** - \defgroup don Module don + \defgroup don Module donation \brief Module pour g�rer le suivi des dons \version $Id$ */ diff --git a/htdocs/includes/modules/modDroitPret.class.php b/htdocs/includes/modules/modDroitPret.class.php index 2f3968a6167..d50e06bad09 100644 --- a/htdocs/includes/modules/modDroitPret.class.php +++ b/htdocs/includes/modules/modDroitPret.class.php @@ -18,7 +18,7 @@ */ /** - * \defgroup DroitPret Module pret + * \defgroup DroitPret Module droitpret * \version $Id$ * \brief Module pour gerer le suivi des droits de prets */ diff --git a/htdocs/includes/modules/modECM.class.php b/htdocs/includes/modules/modECM.class.php index 8fa9cd48826..16f894c9d57 100644 --- a/htdocs/includes/modules/modECM.class.php +++ b/htdocs/includes/modules/modECM.class.php @@ -17,7 +17,7 @@ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ -/** \defgroup ecm Module ECM +/** \defgroup ecm Module ecm * \brief Module for ECM (Electronic Content Management) * \version $Id$ */ diff --git a/htdocs/includes/modules/modEditeur.class.php b/htdocs/includes/modules/modEditeur.class.php index e6c2ca52cf3..7b3a3e5e598 100644 --- a/htdocs/includes/modules/modEditeur.class.php +++ b/htdocs/includes/modules/modEditeur.class.php @@ -18,7 +18,7 @@ */ /** - * \defgroup editeur Module editeur + * \defgroup editeur Module editor * \brief Module pour gerer les livres et editeurs * \version $Id$ */ diff --git a/htdocs/includes/modules/modEnergie.class.php b/htdocs/includes/modules/modEnergie.class.php index d7688b30c1e..b4b1807497c 100644 --- a/htdocs/includes/modules/modEnergie.class.php +++ b/htdocs/includes/modules/modEnergie.class.php @@ -18,7 +18,7 @@ */ /** - * \defgroup energie Module energie + * \defgroup energie Module energy * \brief Module pour le suivi de la consommation d'energie * \version $Id$ */ diff --git a/htdocs/includes/modules/modExpedition.class.php b/htdocs/includes/modules/modExpedition.class.php index 916b9ae01da..e564ac9ac2c 100644 --- a/htdocs/includes/modules/modExpedition.class.php +++ b/htdocs/includes/modules/modExpedition.class.php @@ -19,7 +19,7 @@ */ /** - * \defgroup expedition Module expedition + * \defgroup expedition Module shipping * \brief Module pour gerer les expeditions de produits */ diff --git a/htdocs/includes/modules/modFacture.class.php b/htdocs/includes/modules/modFacture.class.php index 3c273ce8c93..690b76a6b60 100644 --- a/htdocs/includes/modules/modFacture.class.php +++ b/htdocs/includes/modules/modFacture.class.php @@ -20,7 +20,7 @@ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ -/** \defgroup facture Module facture +/** \defgroup facture Module invoices * \brief Module pour gerer les factures clients et/ou fournisseurs * \version $Id$ */ diff --git a/htdocs/includes/modules/modFournisseur.class.php b/htdocs/includes/modules/modFournisseur.class.php index 785a1e97f20..715f6d37f5a 100644 --- a/htdocs/includes/modules/modFournisseur.class.php +++ b/htdocs/includes/modules/modFournisseur.class.php @@ -18,7 +18,7 @@ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ -/** \defgroup fournisseur Module fournisseur +/** \defgroup fournisseur Module suppliers * \brief Module pour gerer des societes et contacts de type fournisseurs * \version $Id$ */ diff --git a/htdocs/includes/modules/modGravatar.class.php b/htdocs/includes/modules/modGravatar.class.php index ef72a0a6545..c68ccee5091 100644 --- a/htdocs/includes/modules/modGravatar.class.php +++ b/htdocs/includes/modules/modGravatar.class.php @@ -17,7 +17,7 @@ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ -/** \defgroup gravatar Module Gravatar +/** \defgroup gravatar Module gravatar * \brief Module to use Gravatar to show photo of users */ diff --git a/htdocs/includes/modules/modImport.class.php b/htdocs/includes/modules/modImport.class.php index 15843b713ba..34d482a9273 100644 --- a/htdocs/includes/modules/modImport.class.php +++ b/htdocs/includes/modules/modImport.class.php @@ -17,7 +17,7 @@ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ -/** \defgroup import Module Import +/** \defgroup import Module Iimport \brief Module generique pour realiser des imports de donnees en base \version $Id$ */ diff --git a/htdocs/includes/modules/modLabel.class.php b/htdocs/includes/modules/modLabel.class.php index 0d942895e15..3d4f5456ad6 100644 --- a/htdocs/includes/modules/modLabel.class.php +++ b/htdocs/includes/modules/modLabel.class.php @@ -18,15 +18,15 @@ */ /** - \defgroup label Module Etiquettes - \version $Id$ - \brief Module pour gerer les formats d'impression des etiquettes + * \defgroup label Module labels + * \version $Id$ + * \brief Module pour gerer les formats d'impression des etiquettes */ /** - \file htdocs/includes/modules/modLabel.class.php - \ingroup other - \brief Fichier de description et activation du module Label + * \file htdocs/includes/modules/modLabel.class.php + * \ingroup other + * \brief Fichier de description et activation du module Label */ include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php"); diff --git a/htdocs/includes/modules/modMailing.class.php b/htdocs/includes/modules/modMailing.class.php index 64f1baa9a18..061e07450c5 100644 --- a/htdocs/includes/modules/modMailing.class.php +++ b/htdocs/includes/modules/modMailing.class.php @@ -19,8 +19,8 @@ */ /** - * \defgroup mailing Module mailing - * \brief Module pour gerer les mailings + * \defgroup mailing Module emailing + * \brief Module to manage EMailings * \version $Id$ */ diff --git a/htdocs/includes/modules/modMantis.class.php b/htdocs/includes/modules/modMantis.class.php index ff8337af113..4960546b206 100644 --- a/htdocs/includes/modules/modMantis.class.php +++ b/htdocs/includes/modules/modMantis.class.php @@ -17,7 +17,7 @@ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ -/** \defgroup mantis Module Mantis +/** \defgroup mantis Module mantis \brief Module to include Mantis into Dolibarr */ diff --git a/htdocs/includes/modules/modMultiCompany.class.php b/htdocs/includes/modules/modMultiCompany.class.php index f84f87ee307..37f2a84861b 100644 --- a/htdocs/includes/modules/modMultiCompany.class.php +++ b/htdocs/includes/modules/modMultiCompany.class.php @@ -18,9 +18,8 @@ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ -/** \defgroup mymodule Module MyModule - * \brief Example of a module descriptor. - * Such a file must be copied into htdocs/includes/module directory. +/** \defgroup multicompany Module multicompany + * \brief Descriptor file for module multicompany */ /** diff --git a/htdocs/includes/modules/modNotification.class.php b/htdocs/includes/modules/modNotification.class.php index f24a27b04fd..db77301abf2 100644 --- a/htdocs/includes/modules/modNotification.class.php +++ b/htdocs/includes/modules/modNotification.class.php @@ -18,8 +18,8 @@ */ /** - * \defgroup notification Module notification - * \brief Module pour g�rer les notifications (par mail ou autre) + * \defgroup notification Module email notification + * \brief Module pour gerer les notifications (par mail ou autre) * \version $Id$ */ diff --git a/htdocs/includes/modules/modOSCommerceWS.class.php b/htdocs/includes/modules/modOSCommerceWS.class.php index 84ad2050614..11983002558 100644 --- a/htdocs/includes/modules/modOSCommerceWS.class.php +++ b/htdocs/includes/modules/modOSCommerceWS.class.php @@ -21,7 +21,7 @@ * $Id$ */ -/** \defgroup oscommerce2 Module OSCommerce 2 +/** \defgroup oscommerce2 Module oscommercews \brief Module pour gerer une boutique et interface avec OSCommerce via Web Services */ diff --git a/htdocs/includes/modules/modPaybox.class.php b/htdocs/includes/modules/modPaybox.class.php index 17793788e95..dc3589db6a7 100644 --- a/htdocs/includes/modules/modPaybox.class.php +++ b/htdocs/includes/modules/modPaybox.class.php @@ -17,9 +17,8 @@ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ -/** \defgroup mymodule Module MyModule - * \brief Example of a module descriptor. - * Such a file must be copied into htdocs/includes/module directory. +/** \defgroup paybox Module paybox + * \brief Add integration with Paybox online payment system. */ /** diff --git a/htdocs/includes/modules/modPhenix.class.php b/htdocs/includes/modules/modPhenix.class.php index 61f6100e9b9..08f9559bf1a 100644 --- a/htdocs/includes/modules/modPhenix.class.php +++ b/htdocs/includes/modules/modPhenix.class.php @@ -16,7 +16,7 @@ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ -/** \defgroup phenix Module Phenix +/** \defgroup phenix Module phenix \brief Module to include Phenix into Dolibarr and add Dolibarr events directly inside a Phenix database. \version $Id$ @@ -45,44 +45,44 @@ class modPhenix extends DolibarrModules function modPhenix($DB) { $this->db = $DB; - + // Id for module (must be unique). // Use here a free id. $this->numero = 420; - + // Family can be 'crm','financial','hr','projects','product','technic','other' - // It is used to sort modules in module setup page - $this->family = "projects"; + // It is used to sort modules in module setup page + $this->family = "projects"; // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module) $this->name = eregi_replace('^mod','',get_class($this)); // Module descriptoin used translation string 'ModuleXXXDesc' not found (XXX is id value) $this->description = "Interface avec le calendrier Phenix"; // Possible values for version are: 'experimental' or 'dolibarr' or version - $this->version = 'development'; - // Id used in llx_const table to manage module status (enabled/disabled) + $this->version = 'development'; + // Id used in llx_const table to manage module status (enabled/disabled) $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name); // Where to store the module in setup page (0=common,1=interface,2=other) $this->special = 1; // Name of png file (without png) used for this module $this->picto='calendar'; - + // Data directories to create when module is enabled $this->dirs = array(); - + // Config pages. Put here list of php page names stored in admmin directory used to setup module $this->config_page_url = array("phenix.php"); - + // Dependencies $this->depends = array(); // List of modules id that must be enabled if this module is enabled $this->requiredby = array(); // List of modules id to disable if this one is disabled - + // Constants $this->const = array(); // List of parameters - + // Boxes - $this->boxes = array(); // List of boxes + $this->boxes = array(); // List of boxes $r=0; - + // Add here list of default box name and php file stored in includes/boxes that // contains class to show a box. // Example: @@ -97,7 +97,7 @@ class modPhenix extends DolibarrModules // Menus //------ $r=0; - + $this->menu[$r]=array('fk_menu'=>0, 'type'=>'top', 'titre'=>'Calendar', @@ -121,7 +121,7 @@ class modPhenix extends DolibarrModules function init() { $sql = array(); - + return $this->_init($sql); } diff --git a/htdocs/includes/modules/modProduit.class.php b/htdocs/includes/modules/modProduit.class.php index 8ac011ed884..32a2dfd622d 100644 --- a/htdocs/includes/modules/modProduit.class.php +++ b/htdocs/includes/modules/modProduit.class.php @@ -21,7 +21,7 @@ */ /** - * \defgroup produit Module produit + * \defgroup produit Module products * \brief Module pour gerer le suivi de produits predefinis * \version $Id$ */ diff --git a/htdocs/includes/modules/modPropale.class.php b/htdocs/includes/modules/modPropale.class.php index b7dc2af938a..3926b8f72cb 100644 --- a/htdocs/includes/modules/modPropale.class.php +++ b/htdocs/includes/modules/modPropale.class.php @@ -20,7 +20,7 @@ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ -/** \defgroup propale Module propale +/** \defgroup propale Module commercial proposals * \brief Module pour gerer la tenue de propositions commerciales */ diff --git a/htdocs/includes/modules/modService.class.php b/htdocs/includes/modules/modService.class.php index 7bc4fbe2676..ec7c6a86f45 100644 --- a/htdocs/includes/modules/modService.class.php +++ b/htdocs/includes/modules/modService.class.php @@ -23,7 +23,7 @@ */ /** - * \defgroup service Module service + * \defgroup service Module services * \brief Module pour gerer le suivi de services predefinis */ diff --git a/htdocs/includes/modules/modStock.class.php b/htdocs/includes/modules/modStock.class.php index 828012e418d..9592de070f5 100644 --- a/htdocs/includes/modules/modStock.class.php +++ b/htdocs/includes/modules/modStock.class.php @@ -19,7 +19,7 @@ */ /** - * \defgroup stock Module stock + * \defgroup stock Module stocks * \brief Module pour gerer la tenue de stocks produits * \version $Id$ */ diff --git a/htdocs/includes/modules/modUser.class.php b/htdocs/includes/modules/modUser.class.php index e56e7f0751d..e53a0fc5ecc 100644 --- a/htdocs/includes/modules/modUser.class.php +++ b/htdocs/includes/modules/modUser.class.php @@ -19,7 +19,7 @@ */ /** - * \defgroup user Module user + * \defgroup user Module user management * \brief Module pour gerer les utilisateurs */ diff --git a/htdocs/includes/modules/modWebServices.class.php b/htdocs/includes/modules/modWebServices.class.php index ee395dc3678..55623b310e5 100644 --- a/htdocs/includes/modules/modWebServices.class.php +++ b/htdocs/includes/modules/modWebServices.class.php @@ -17,7 +17,7 @@ */ /** - * \defgroup webservices Module WebServices + * \defgroup webservices Module webservices * \brief Module to enable the Dolibarr server of web services * \brief $Id$ */ diff --git a/htdocs/includes/modules/modWebcalendar.class.php b/htdocs/includes/modules/modWebcalendar.class.php index 104feae83bc..eaa2551231a 100644 --- a/htdocs/includes/modules/modWebcalendar.class.php +++ b/htdocs/includes/modules/modWebcalendar.class.php @@ -18,7 +18,7 @@ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ -/** \defgroup webcalendar Module Webcalendar +/** \defgroup webcalendar Module webcalendar \brief Module to include Webcalendar GUI into Dolibarr menu and add Dolibarr events directly inside a Webcalendar database. \version $Id$ @@ -47,44 +47,44 @@ class modWebcalendar extends DolibarrModules function modWebcalendar($DB) { $this->db = $DB; - + // Id for module (must be unique). // Use here a free id. $this->numero = 410; - + // Family can be 'crm','financial','hr','projects','product','technic','other' - // It is used to sort modules in module setup page - $this->family = "projects"; + // It is used to sort modules in module setup page + $this->family = "projects"; // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module) $this->name = eregi_replace('^mod','',get_class($this)); // Module description used if translation string 'ModuleXXXDesc' not found (XXX is id value) $this->description = "Interfacage avec le calendrier Webcalendar"; // Possible values for version are: 'development', 'experimental', 'dolibarr' or version - $this->version = 'dolibarr'; + $this->version = 'dolibarr'; // Key used in llx_const table to save module status enabled/disabled (XXX is id value) $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name); // Where to store the module in setup page (0=common,1=interface,2=other) $this->special = 1; // Name of png file (without png) used for this module $this->picto='calendar'; - + // Data directories to create when module is enabled $this->dirs = array(); - + // Config pages. Put here list of php page names stored in admmin directory used to setup module $this->config_page_url = array("webcalendar.php"); - + // Dependencies $this->depends = array(); // List of modules id that must be enabled if this module is enabled $this->requiredby = array(); // List of modules id to disable if this one is disabled - + // Constants $this->const = array(); // List of parameters - + // Boxes - $this->boxes = array(); // List of boxes + $this->boxes = array(); // List of boxes $r=0; - + // Add here list of php file(s) stored in includes/boxes that contains class to show a box. // Example: //$this->boxes[$r][1] = "myboxa.php"; @@ -95,11 +95,11 @@ class modWebcalendar extends DolibarrModules // Permissions $this->rights_class = 'webcal'; // Permission key $this->rights = array(); // Permission array used by this module - + // Menus //------ $r=0; - + $this->menu[$r]=array('fk_menu'=>0, 'type'=>'top', 'titre'=>'Calendar', @@ -114,7 +114,7 @@ class modWebcalendar extends DolibarrModules 'user'=>0 ); $r++; - + } /** @@ -125,7 +125,7 @@ class modWebcalendar extends DolibarrModules function init() { $sql = array(); - + return $this->_init($sql); }