Doc: Les classes d'activation des modules (modXXX.class.php) sont decrites dans doxygen

htdocs/includes/modules/DolibarrModules.class.php

@@ -20,33 +20,38 @@
  *
  */
 
-class DolibarrModules
+/*! \file htdocs/includes/modules/modDolibarrModules.class.php
-{
+        \brief      Fichier de description et activation du module Facture
-
-  /*
-   * Initialisation
-   *
 */
 
+
+/*! \class DolibarrModules
+        \brief      Classe mère des classes de description et activation des modules Dolibarr
+*/
+class DolibarrModules
+{
+   var $db;         // Handler d'accès aux base
+   var $boxes;      // Tableau des boites
+   var $const;      // Tableau des constantes
+
+
+   /*!  \brief      Constructeur
+    *   \param      DB      handler d'accès base
+    */
   function DolibarrModules($DB)
   {
     $this->db = $DB ;
   }
-  /*
-   *
-   *
-   *
-   */
 
+
+   /*!  \brief      Fonction d'activation. Insère en base les constantes et boites du module
+    *   \param      array_sql       tableau de requete sql a exécuter à l'activation
+    */
   function _init($array_sql)
   {
-    /*
+    // Insère les constantes
-     *  Activation du module:
-     *  Insère les constantes dans llx_const
-     */
     $err = 0;
 
-
     $sql = "REPLACE INTO ".MAIN_DB_PREFIX."const SET name = '".$this->const_name."', value='1', visible = 0";
 
     if (!$this->db->query($sql))
@@ -54,7 +59,7 @@ class DolibarrModules
 	$err++;
       }
 
-    // Ajout des boxes dans llx_boxes_def
+    // Insère les boxes dans llx_boxes_def
     foreach ($this->boxes as $key => $value)
       {
 	$titre = $this->boxes[$key][0];
@@ -142,9 +147,10 @@ class DolibarrModules
 	return 1;
       }
   }
-  /*
+
-   *
+
-   *
+   /*!  \brief      Fonction de désactivation. Supprime de la base les constantes et boites du module
+    *   \param      array_sql       tableau de requete sql a exécuter à la désactivation
     */
   function _remove($array_sql)
   {

htdocs/includes/modules/modAdherent.class.php

@@ -28,11 +28,16 @@
 
 /*!
         \file       htdocs/includes/modules/modAdherent.class.php
+        \ingroup    adherent
         \brief      Fichier de description et activation du module adherents
 */
 
 include_once "DolibarrModules.class.php";
 
+/*! \class modAdherent
+        \brief      Classe de description et activation du module Adherent
+*/
+
 class modAdherent extends DolibarrModules
 {
 

htdocs/includes/modules/modBanque.class.php

@@ -27,11 +27,16 @@
 
 /*!
         \file       htdocs/includes/modules/modBanque.class.php
+        \ingroup    banque
         \brief      Fichier de description et activation du module Banque
 */
 
 include_once "DolibarrModules.class.php";
 
+/*! \class modBanque
+        \brief      Classe de description et activation du module Banque
+*/
+
 class modBanque extends DolibarrModules
 {
 

htdocs/includes/modules/modBoutique.class.php

@@ -27,11 +27,16 @@
 
 /*!
         \file       htdocs/includes/modules/modBoutique.class.php
+        \ingroup    boutique
         \brief      Fichier de description et activation du module Boutique
 */
 
 include_once "DolibarrModules.class.php";
 
+/*! \class modBoutique
+        \brief      Classe de description et activation du module Boutique
+*/
+
 class modBoutique extends DolibarrModules
 {
 

htdocs/includes/modules/modCaisse.class.php

@@ -26,11 +26,16 @@
 
 /*!
         \file       htdocs/includes/modules/modCaisse.class.php
+        \ingroup    caisse
         \brief      Fichier de description et activation du module Caisse
 */
 
 include_once "DolibarrModules.class.php";
 
+/*! \class modCaisse
+        \brief      Classe de description et activation du module Caisse
+*/
+
 class modCaisse extends DolibarrModules
 {
 

htdocs/includes/modules/modCommande.class.php

@@ -27,11 +27,16 @@
 
 /*!
         \file       htdocs/includes/modules/modCommande.class.php
+        \ingroup    commande
         \brief      Fichier de description et activation du module Commande
 */
 
 include_once "DolibarrModules.class.php";
 
+/*! \class modCommande
+        \brief      Classe de description et activation du module Commande
+*/
+
 class modCommande extends DolibarrModules
 {
 

htdocs/includes/modules/modCommercial.class.php

@@ -27,11 +27,16 @@
 
 /*!
         \file       htdocs/includes/modules/modCommercial.class.php
+        \ingroup    commercial
         \brief      Fichier de description et activation du module Commercial
 */
 
 include_once "DolibarrModules.class.php";
 
+/*! \class modCommercial
+        \brief      Classe de description et activation du module Commercial
+*/
+
 class modCommercial extends DolibarrModules
 {
 

htdocs/includes/modules/modComptabilite.class.php

@@ -27,11 +27,16 @@
 
 /*!
         \file       htdocs/includes/modules/modComptabilite.class.php
+        \ingroup    comptabilite
         \brief      Fichier de description et activation du module Comptabilite
 */
 
 include_once "DolibarrModules.class.php";
 
+/*! \class modComptabilite
+        \brief      Classe de description et activation du module Comptabilite
+*/
+
 class modComptabilite extends DolibarrModules
 {
 

htdocs/includes/modules/modContrat.class.php

@@ -26,11 +26,16 @@
 
 /*!
         \file       htdocs/includes/modules/modContrat.class.php
+        \ingroup    contrat
         \brief      Fichier de description et activation du module Contrat
 */
 
 include_once "DolibarrModules.class.php";
 
+/*! \class modContrat
+        \brief      Classe de description et activation du module Contrat
+*/
+
 class modContrat extends DolibarrModules
 {
 

htdocs/includes/modules/modDon.class.php

@@ -27,11 +27,16 @@
 
 /*!
         \file       htdocs/includes/modules/modDon.class.php
+        \ingroup    don
         \brief      Fichier de description et activation du module Don
 */
 
 include_once "DolibarrModules.class.php";
 
+/*! \class modDon
+        \brief      Classe de description et activation du module Don
+*/
+
 class modDon  extends DolibarrModules
 {
 

htdocs/includes/modules/modExpedition.class.php

@@ -27,11 +27,16 @@
 
 /*!
         \file       htdocs/includes/modules/modExpedition.class.php
+        \ingroup    expedition
         \brief      Fichier de description et activation du module Expedition
 */
 
 include_once "DolibarrModules.class.php";
 
+/*! \class modExpedition
+        \brief      Classe de description et activation du module Expedition
+*/
+
 class modExpedition extends DolibarrModules
 {
 

htdocs/includes/modules/modExternalRss.class.php

@@ -27,11 +27,16 @@
 
 /*!
         \file       htdocs/includes/modules/modExternalRss.class.php
+        \ingroup    externalrss
         \brief      Fichier de description et activation du module ExternalRss
 */
 
 include_once "DolibarrModules.class.php";
 
+/*! \class modExternalRss
+        \brief      Classe de description et activation du module ExternalRss
+*/
+
 class modExternalRss extends DolibarrModules
 {
 

htdocs/includes/modules/modFacture.class.php

@@ -25,21 +25,25 @@
         \brief      Module pour gérer les factures clients et/ou fournisseurs
 */
 
-/*!
+
-        \file       htdocs/includes/modules/modFacture.class.php
+/*! \file htdocs/includes/modules/modFacture.class.php
-        \brief      Fichier de description et activation du module Facture
+        \ingroup    facture
+        \brief      Fichier de la classe de description et activation du module Facture
 */
 
 include_once "DolibarrModules.class.php";
 
+
+/*! \class modFacture
+        \brief      Classe de description et activation du module Facture
+*/
+
 class modFacture extends DolibarrModules
 {
 
-  /*
+   /*!  \brief      Constructeur. Definit les noms, constantes et boites
-   * Initialisation
+    *   \param      DB      handler d'accès base
-   *
     */
-
   function modFacture($DB)
   {
     $this->db = $DB ;
@@ -109,17 +113,11 @@ class modFacture extends DolibarrModules
     $this->boxes[3][1] = "box_factures_fourn.php";
 
   }
-  /*
-   *
-   *
-   *
-   */
 
+   /*!  \brief      Fonction d'activation. Insère en base les constantes, boites et permissions du module
+    */
   function init()
   {
-    /*
-     * Permissions
-     */
     $sql = array(
 		 "insert into ".MAIN_DB_PREFIX."rights_def values (10,'Tous les droits sur les factures','facture','a',0);",
 		 "insert into ".MAIN_DB_PREFIX."rights_def values (11,'Lire les factures','facture','r',1);",
@@ -133,9 +131,8 @@ class modFacture extends DolibarrModules
     
     return $this->_init($sql);
   }
-  /*
+
-   *
+   /*!  \brief      Fonction de désactivation. Supprime de la base les constantes, boites et permissions du module
-   *
     */
   function remove()
   {

htdocs/includes/modules/modFicheinter.class.php

@@ -27,11 +27,16 @@
 
 /*!
         \file       htdocs/includes/modules/modFicheinter.class.php
+        \ingroup    ficheinter
         \brief      Fichier de description et activation du module Ficheinter
 */
 
 include_once "DolibarrModules.class.php";
 
+/*! \class modFicheinter
+        \brief      Classe de description et activation du module Ficheinter
+*/
+
 class modFicheinter  extends DolibarrModules
 {
 

htdocs/includes/modules/modFournisseur.class.php

@@ -27,12 +27,17 @@
 
 /*!
         \file       htdocs/includes/modules/modFournisseur.class.php
+        \ingroup    fournisseur
         \brief      Fichier de description et activation du module Fournisseur
 */
 
 
 include_once "DolibarrModules.class.php";
 
+/*! \class modFournisseur
+        \brief      Classe de description et activation du module Fournisseur
+*/
+
 class modFournisseur extends DolibarrModules
 {
 

htdocs/includes/modules/modLdap.class.php

@@ -27,11 +27,16 @@
 
 /*!
         \file       htdocs/includes/modules/modLdap.class.php
+        \ingroup    ldap
         \brief      Fichier de description et activation du module Ldap
 */
 
 include_once "DolibarrModules.class.php";
 
+/*! \class modLdap
+        \brief      Classe de description et activation du module Ldap
+*/
+
 class modLdap extends DolibarrModules
 {
   /*

htdocs/includes/modules/modPostnuke.class.php

@@ -27,11 +27,16 @@
 
 /*!
         \file       htdocs/includes/modules/modPostnuke.class.php
+        \ingroup    postnuke
         \brief      Fichier de description et activation du module Postnuke
 */
 
 include_once "DolibarrModules.class.php";
 
+/*! \class modPostnuke
+        \brief      Classe de description et activation du module Postnuke
+*/
+
 class modPostnuke extends DolibarrModules
 {
 

htdocs/includes/modules/modProduit.class.php

@@ -27,11 +27,16 @@
 
 /*!
         \file       htdocs/includes/modules/modProduit.class.php
+        \ingroup    produit
         \brief      Fichier de description et activation du module Produit
 */
 
 include_once "DolibarrModules.class.php";
 
+/*! \class modProduit
+        \brief      Classe de description et activation du module Produit
+*/
+
 class modProduit extends DolibarrModules
 {
 

htdocs/includes/modules/modProjet.class.php

@@ -27,11 +27,16 @@
 
 /*!
         \file       htdocs/includes/modules/modProjet.class.php
+        \ingroup    projet
         \brief      Fichier de description et activation du module Projet
 */
 
 include_once "DolibarrModules.class.php";
 
+/*! \class modProjet
+        \brief      Classe de description et activation du module Projet
+*/
+
 class modProjet extends DolibarrModules
 {
 

htdocs/includes/modules/modPropale.class.php

@@ -27,11 +27,16 @@
 
 /*!
         \file       htdocs/includes/modules/modPropale.class.php
+        \ingroup    propale
         \brief      Fichier de description et activation du module Propale
 */
 
 include_once "DolibarrModules.class.php";
 
+/*! \class modPropale
+        \brief      Classe de description et activation du module Propale
+*/
+
 class modPropale extends DolibarrModules
 {
 

htdocs/includes/modules/modService.class.php

@@ -27,11 +27,16 @@
 
 /*!
         \file       htdocs/includes/modules/modService.class.php
+        \ingroup    service
         \brief      Fichier de description et activation du module Service
 */
 
 include_once "DolibarrModules.class.php";
 
+/*! \class modService
+        \brief      Classe de description et activation du module Service
+*/
+
 class modService extends DolibarrModules
 {
 

htdocs/includes/modules/modSociete.class.php

@@ -27,11 +27,16 @@
 
 /*!
         \file       htdocs/includes/modules/modSociete.class.php
+        \ingroup    societe
         \brief      Fichier de description et activation du module Societe
 */
 
 include_once "DolibarrModules.class.php";
 
+/*! \class modSociete
+        \brief      Classe de description et activation du module Societe
+*/
+
 class modSociete extends DolibarrModules
 {
 

htdocs/includes/modules/modStock.class.php

@@ -27,11 +27,16 @@
 
 /*!
         \file       htdocs/includes/modules/modStock.class.php
+        \ingroup    stock
         \brief      Fichier de description et activation du module Stock
 */
 
 include_once "DolibarrModules.class.php";
 
+/*! \class modStock
+        \brief      Classe de description et activation du module Stock
+*/
+
 class modStock extends DolibarrModules
 {
 

htdocs/includes/modules/modWebcalendar.class.php

@@ -28,11 +28,16 @@
 
 /*!
         \file       htdocs/includes/modules/modWebcalendar.class.php
+        \ingroup    webcalendar
         \brief      Fichier de description et activation du module Webcalendar
 */
 
 include_once "DolibarrModules.class.php";
 
+/*! \class modWebcalendar
+        \brief      Classe de description et activation du module Webcalendar
+*/
+
 class modWebcalendar extends DolibarrModules
 {