Doxygen

htdocs/core/modules/modAccounting.class.php

@@ -30,8 +30,7 @@ include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
 /**
- *	\class      modAccounting
+ *	Classe de description et activation du module Comptabilite Expert
- *	\brief      Classe de description et activation du module Comptabilite Expert
  */
 class modAccounting extends DolibarrModules
 {

htdocs/core/modules/modAdherent.class.php

@@ -26,7 +26,6 @@
  *      \ingroup    member
  *      \brief      File descriptor or module Member
  */
-
 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 /**

htdocs/core/modules/modAgenda.class.php

@@ -30,8 +30,7 @@
 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 /**
- *      \class      modAgenda
+ *	Classe de description et activation du module Adherent
- *      \brief      Classe de description et activation du module Adherent
  */
 class modAgenda extends DolibarrModules
 {

htdocs/core/modules/modBanque.class.php

@@ -31,10 +31,8 @@ include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
 /**
- *	\class      modBanque
+ *	Classe de description et activation du module Banque
- *	\brief      Classe de description et activation du module Banque
  */
-
 class modBanque extends DolibarrModules
 {
 

htdocs/core/modules/modBarcode.class.php

@@ -28,10 +28,8 @@
 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 /**
- *	\class      modBarcode
+ *	Classe de description et activation du module Barcode
- *	\brief      Classe de description et activation du module Barcode
  */
-
 class modBarcode extends DolibarrModules
 {
 

htdocs/core/modules/modBookmark.class.php

@@ -28,10 +28,8 @@ include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
 /**
- *	\class      modBookmark
+ *	Classe de description et activation du module Bookmark
- *	\brief      Classe de description et activation du module Bookmark
  */
-
 class modBookmark extends DolibarrModules
 {
 

htdocs/core/modules/modBoutique.class.php

@@ -30,8 +30,7 @@ include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
 /**
- *		\class 		modBoutique
+ *	Classe de description et activation du module OSCommerce
- *		\brief      Classe de description et activation du module OSCommerce
  */
 class modBoutique extends DolibarrModules
 {

htdocs/core/modules/modCashDesk.class.php

@@ -26,8 +26,7 @@ include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
 /**
- *       \class      modCashDesk
+ *	Class to describe and enable module Point Of Sales
- *       \brief      Class to describe and enable module Point Of Sales
  */
 class modCashDesk extends DolibarrModules
 {

htdocs/core/modules/modCategorie.class.php

@@ -27,8 +27,7 @@ include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
 /**
- *       \class      modCategorie
+ *	Classe de description et activation du module Categorie
- *       \brief      Classe de description et activation du module Categorie
  */
 class modCategorie extends DolibarrModules
 {

htdocs/core/modules/modClickToDial.class.php

@@ -28,10 +28,8 @@ include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
 /**
- *	\class      modClickToDial
+ *	Classe de description et activation du module de Click to Dial
- *	\brief      Classe de description et activation du module de Click to Dial
  */
-
 class modClickToDial extends DolibarrModules
 {
 

htdocs/core/modules/modCommissions.class.php

@@ -17,8 +17,8 @@
  */
 
 /**
- * 	\defgroup   commissions     Module Commissions
+ * 	\defgroup   commissions     Module commissions
- * 	\brief      Example of a module descriptor.
+ * 	\brief      Module commissions
  * 	\file       htdocs/core/modules/modCommissions.class.php
  * 	\ingroup    commissions
  * 	\brief      Description and activation file for module Commissions

htdocs/core/modules/modComptabilite.class.php

@@ -30,8 +30,7 @@ include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
 /**
- *		\class 		modComptabilite
+ *	Classe de description et activation du module Comptabilite
- *      \brief      Classe de description et activation du module Comptabilite
  */
 class modComptabilite extends DolibarrModules
 {

htdocs/core/modules/modContrat.class.php

@@ -29,10 +29,8 @@ include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
 /**
- \class      modContrat
+ *	Classe de description et activation du module Contrat
- \brief      Classe de description et activation du module Contrat
  */
-
 class modContrat extends DolibarrModules
 {
 

htdocs/core/modules/modDeplacement.class.php

@@ -27,8 +27,7 @@ include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
 /**
- *	\class      modDeplacement
+ *	Classe de description et activation du module Deplacement
- *	\brief      Classe de description et activation du module Deplacement
  */
 class modDeplacement extends DolibarrModules
 {

htdocs/core/modules/modDocument.class.php

@@ -29,10 +29,8 @@ include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
 /**
- *	\class      modDocument
+ *	Classe de description et activation du module Document
- *	\brief      Classe de description et activation du module Document
  */
-
 class modDocument extends DolibarrModules
 {
 

htdocs/core/modules/modDon.class.php

@@ -29,8 +29,7 @@ include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
 /**
- *	\class      modDon
+ *	Classe de description et activation du module Don
- *	\brief      Classe de description et activation du module Don
  */
 class modDon  extends DolibarrModules
 {

htdocs/core/modules/modECM.class.php

@@ -26,8 +26,8 @@
 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
-/**     \class      modECM
+/**
- *      \brief      Description and activation class for module ECM
+ * 	Description and activation class for module ECM
  */
 class modECM extends DolibarrModules
 {

htdocs/core/modules/modExpedition.class.php

@@ -30,8 +30,7 @@ include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
 /**
- * 	\class modExpedition
+ *	Classe de description et activation du module Expedition
- *	\brief      Classe de description et activation du module Expedition
  */
 class modExpedition extends DolibarrModules
 {

htdocs/core/modules/modExport.class.php

@@ -27,10 +27,9 @@
 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
-/**     \class      modExport
+/**
- *		\brief      Classe de description et activation du module export
+ *	Classe de description et activation du module export
  */
-
 class modExport extends DolibarrModules
 {
 

htdocs/core/modules/modExternalRss.class.php

@@ -27,10 +27,9 @@
 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
-/**     \class      modExternalRss
+/**
- *		\brief      Classe de description et activation du module externalrss
+ *	Classe de description et activation du module externalrss
  */
-
 class modExternalRss extends DolibarrModules
 {
 
@@ -130,10 +129,10 @@ class modExternalRss extends DolibarrModules
     function remove($options='')
     {
 		$sql = array();
-		
+
 		// Delete old declarations of RSS box
 		$this->boxes[0][1] = "box_external_rss.php";
-		
+
 		return $this->_remove($sql,$options);
     }
 

htdocs/core/modules/modExternalSite.class.php

@@ -28,18 +28,17 @@
 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
-/**     \class      modExternalSite
+/**
-        \brief      Description and activation class for module ExternalSite
+ * 	Description and activation class for module ExternalSite
-*/
+ */
-
 class modExternalSite extends DolibarrModules
 {
 
-   /**
+    /**
 	 *   Constructor. Define names, constants, directories, boxes, permissions
 	 *
 	 *   @param      DoliDB		$db      Database handler
-    */
+     */
 	function __construct($db)
 	{
 		$this->db = $db;

htdocs/core/modules/modFTP.class.php

@@ -27,8 +27,8 @@
 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
-/**     \class      modFTP
+/**
- *      \brief      Description and activation class for module FTP
+ * 	Description and activation class for module FTP
  */
 class modFTP extends DolibarrModules
 {

htdocs/core/modules/modFckeditor.class.php

@@ -29,8 +29,7 @@ include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
 /**
- * 	\class modFckeditor
+ *	Classe de description et activation du module Fckeditor
- *  \brief      Classe de description et activation du module Fckeditor
  */
 
 class modFckeditor extends DolibarrModules

htdocs/core/modules/modFicheinter.class.php

@@ -32,8 +32,7 @@ include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
 /**
- *	\class      modFicheinter
+ *	Classe de description et activation du module Ficheinter
- *	\brief      Classe de description et activation du module Ficheinter
  */
 class modFicheinter extends DolibarrModules
 {

htdocs/core/modules/modGeoIPMaxmind.class.php

@@ -26,8 +26,8 @@
 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
-/**     \class      modGeoIPMaxmind
+/**
- *		\brief      Classe de description et activation du module Import
+ *	Classe de description et activation du module Import
  */
 class modGeoIPMaxmind extends DolibarrModules
 {

htdocs/core/modules/modGravatar.class.php

@@ -26,8 +26,8 @@
 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
-/**     \class      modGravatar
+/**
- *      \brief      Description and activation class for module Gravatar
+ * 	Description and activation class for module Gravatar
  */
 class modGravatar extends DolibarrModules
 {

htdocs/core/modules/modHoliday.class.php

@@ -20,16 +20,12 @@
  */
 
 /**
- * 	  \defgroup   holiday Payes     Module holiday Payes
+ * 	  \defgroup   holiday 	Module holiday
- *    \brief      Module de gestion des congés payés
+ *    \brief      Module de gestion des congés
+ *    \file       htdocs/includes/modules/modHoliday.class.php
+ *    \ingroup    holiday
+ *    \brief      Description and activation file for module holiday
  */
-
-/**
- *      \file       htdocs/includes/modules/modHoliday.class.php
- *      \ingroup    holiday
- *      \brief      Description and activation file for module holiday
- */
-
 include_once(DOL_DOCUMENT_ROOT ."/core/modules/DolibarrModules.class.php");
 
 

htdocs/core/modules/modImport.class.php

@@ -27,8 +27,8 @@
 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
-/**     \class      modImport
+/**
- *		\brief      Classe de description et activation du module Import
+ *	Classe de description et activation du module Import
  */
 class modImport extends DolibarrModules
 {

htdocs/core/modules/modLabel.class.php

@@ -28,10 +28,8 @@ include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
 /**
- *	\class      modLabel
+ *	Classe de description et activation du module Label
- *	\brief      Classe de description et activation du module Label
  */
-
 class modLabel extends DolibarrModules
 {
 

htdocs/core/modules/modLdap.class.php

@@ -28,8 +28,7 @@ include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
 /**
- *  \class 		modLdap
+ *	Classe de description et activation du module Ldap
- *	\brief      Classe de description et activation du module Ldap
  */
 class modLdap extends DolibarrModules
 {

htdocs/core/modules/modMailing.class.php

@@ -29,8 +29,7 @@ include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
 /**
- *	\class      modMailing
+ *	Classe de description et activation du module Mailing
- *	\brief      Classe de description et activation du module Mailing
  */
 class modMailing extends DolibarrModules
 {
@@ -75,35 +74,35 @@ class modMailing extends DolibarrModules
 		$this->rights = array();
 		$this->rights_class = 'mailing';
 		$r=0;
-		
+
 		$r++;
 		$this->rights[$r][0] = 221; // id de la permission
 		$this->rights[$r][1] = 'Consulter les mailings'; // libelle de la permission
 		$this->rights[$r][2] = 'r'; // type de la permission (deprecie a ce jour)
 		$this->rights[$r][3] = 1; // La permission est-elle une permission par defaut
 		$this->rights[$r][4] = 'lire';
-		
+
 		$r++;
 		$this->rights[$r][0] = 222;
 		$this->rights[$r][1] = 'Creer/modifier les mailings (sujet, destinataires...)';
 		$this->rights[$r][2] = 'w';
 		$this->rights[$r][3] = 0;
 		$this->rights[$r][4] = 'creer';
-		
+
 		$r++;
 		$this->rights[$r][0] = 223;
 		$this->rights[$r][1] = 'Valider les mailings (permet leur envoi)';
 		$this->rights[$r][2] = 'w';
 		$this->rights[$r][3] = 0;
 		$this->rights[$r][4] = 'valider';
-		
+
 		$r++;
 		$this->rights[$r][0] = 229;
 		$this->rights[$r][1] = 'Supprimer les mailings';
 		$this->rights[$r][2] = 'd';
 		$this->rights[$r][3] = 0;
 		$this->rights[$r][4] = 'supprimer';
-		
+
 		$r++;
 		$this->rights[$r][0] = 237;
 		$this->rights[$r][1] = 'View recipients and info';
@@ -111,7 +110,7 @@ class modMailing extends DolibarrModules
 		$this->rights[$r][3] = 0;
 		$this->rights[$r][4] = 'mailing_advance';		// Visible if option MAIN_USE_ADVANCED_PERMS is on
 		$this->rights[$r][5] = 'recipient';
-		
+
 		$r++;
 		$this->rights[$r][0] = 238;
 		$this->rights[$r][1] = 'Manually send mailings';
@@ -119,7 +118,7 @@ class modMailing extends DolibarrModules
 		$this->rights[$r][3] = 0;
 		$this->rights[$r][4] = 'mailing_advance';		// Visible if option MAIN_USE_ADVANCED_PERMS is on
 		$this->rights[$r][5] = 'send';
-		
+
 		$r++;
 		$this->rights[$r][0] = 239;
 		$this->rights[$r][1] = 'Delete mailings after validation and/or sent';

htdocs/core/modules/modMargin.class.php

@@ -15,7 +15,7 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**     \defgroup   margin     Module Margin
+/**     \defgroup   margin     Module margin
  *      \brief      Module to manage margins
  *      \file       htdocs/includes/modules/modMargin.class.php
  *      \ingroup    margin

htdocs/core/modules/modNotification.class.php

@@ -23,12 +23,10 @@
  *	\ingroup    notification
  *	\brief      Fichier de description et activation du module Notification
  */
-
 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 /**
- *	\class      modNotification
+ *	Classe de description et activation du module Mailing
- *	\brief      Classe de description et activation du module Mailing
  */
 class modNotification extends DolibarrModules
 {

htdocs/core/modules/modPaybox.class.php

@@ -26,8 +26,8 @@
 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
-/**     \class      modPayBox
+/**
- *      \brief      Description and activation class for module Paybox
+ * 	Description and activation class for module Paybox
  */
 class modPayBox extends DolibarrModules
 {

htdocs/core/modules/modPaypal.class.php

@@ -27,8 +27,8 @@
 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
-/**     \class      modPaypal
+/**
- *      \brief      Description and activation class for module Paypal
+ * 	Description and activation class for module Paypal
  */
 class modPaypal extends DolibarrModules
 {

htdocs/core/modules/modPrelevement.class.php

@@ -30,8 +30,7 @@ include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
 /**
- *	\class 		modPrelevement
+ *	Classe de description et activation du module Prelevement
- *	\brief      Classe de description et activation du module Prelevement
  */
 class modPrelevement extends DolibarrModules
 {

htdocs/core/modules/modProduct.class.php

@@ -22,14 +22,10 @@
 /**
  *	\defgroup   produit     Module products
  *	\brief      Module to manage catalog of predefined products
- */
-
-/**
  *	\file       htdocs/core/modules/modProduct.class.php
  *	\ingroup    produit
  *	\brief      File to describe module to manage catalog of predefined products
  */
-
 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 

htdocs/core/modules/modProjet.class.php

@@ -26,13 +26,11 @@
  *	\ingroup    projet
  *	\brief      Fichier de description et activation du module Projet
  */
-
 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
 /**
- *	\class      modProjet
+ *	Classe de description et activation du module Projet
- *	\brief      Classe de description et activation du module Projet
  */
 class modProjet extends DolibarrModules
 {

htdocs/core/modules/modPropale.class.php

@@ -27,13 +27,11 @@
  *	\ingroup    propale
  *	\brief      Fichier de description et activation du module Propale
  */
-
 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
 /**
- *  \class 		modPropale
+ *	Classe de description et activation du module Propale
- *	\brief      Classe de description et activation du module Propale
  */
 class modPropale extends DolibarrModules
 {

htdocs/core/modules/modService.class.php

@@ -27,7 +27,6 @@
  *	\ingroup    service
  *	\brief      Fichier de description et activation du module Service
  */
-
 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 

htdocs/core/modules/modSociete.class.php

@@ -26,13 +26,11 @@
  *	\ingroup    societe
  *	\brief      Fichier de description et activation du module Societe
  */
-
 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
 /**
- *	\class      modSociete
+ *	Classe de description et activation du module Societe
- *	\brief      Classe de description et activation du module Societe
  */
 class modSociete extends DolibarrModules
 {

htdocs/core/modules/modStock.class.php

@@ -29,8 +29,7 @@ include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
 /**
- *	\class      modStock
+ *	Classe de description et activation du module Stock
- *	\brief      Classe de description et activation du module Stock
  */
 class modStock extends DolibarrModules
 {

htdocs/core/modules/modSyslog.class.php

@@ -27,8 +27,7 @@
 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 /**
- *	\class      modSyslog
+ *	Class to enable/disable module Logs
- *	\brief      Class to enable/disable module Logs
  */
 class modSyslog extends DolibarrModules
 {

htdocs/core/modules/modTax.class.php

@@ -27,13 +27,11 @@
  *      \ingroup    tax
  *      \brief      Fichier de description et activation du module Taxe
  */
-
 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
 /**
- *	\class 		modTax
+ *	Classe de description et activation du module Tax
- *	\brief      Classe de description et activation du module Tax
  */
 class modTax extends DolibarrModules
 {

htdocs/core/modules/modUser.class.php

@@ -28,8 +28,7 @@
 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 /**
- *	\class      modUser
+ *	Classe de description et activation du module User
- *	\brief      Classe de description et activation du module User
  */
 class modUser extends DolibarrModules
 {

htdocs/core/modules/modWebServices.class.php

@@ -22,14 +22,11 @@
  *       \ingroup    webservices
  *       \brief      File to describe webservices module
  */
-
 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 /**
- *       \class      modWebServices
+ *	Class to describe a WebServices module
- *       \brief      Class to describe a WebServices module
  */
-
 class modWebServices extends DolibarrModules
 {
 

htdocs/core/modules/modWorkflow.class.php

@@ -23,13 +23,11 @@
  *      \ingroup    workflow
  *      \brief      File to describe and activate module Workflow
  */
-
 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
 
 
 /**
- *  \class      modWorkflow
+ *	Classe de description et activation du module Workflow
- *  \brief      Classe de description et activation du module Workflow
  */
 class modWorkflow extends DolibarrModules
 {