Doxygen

htdocs/includes/modules/modBarcode.class.php

@@ -28,16 +28,17 @@
 include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php");
 
 /**
- \class      modBarcode
+ *	\class      modBarcode
- \brief      Classe de description et activation du module Barcode
+ *	\brief      Classe de description et activation du module Barcode
  */
 
 class modBarcode extends DolibarrModules
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modBarcode($DB)
 	{

htdocs/includes/modules/modBookmark.class.php

@@ -28,16 +28,17 @@ include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php");
 
 
 /**
- \class      modBookmark
+ *	\class      modBookmark
- \brief      Classe de description et activation du module Bookmark
+ *	\brief      Classe de description et activation du module Bookmark
  */
 
 class modBookmark extends DolibarrModules
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acc<EFBFBD>s base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modBookmark($DB)
 	{

htdocs/includes/modules/modBoutique.class.php

@@ -30,16 +30,16 @@ include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php");
 
 
 /**
-		\class 		modBoutique
+ *		\class 		modBoutique
-		\brief      Classe de description et activation du module OSCommerce
+ *		\brief      Classe de description et activation du module OSCommerce
  */
-
 class modBoutique extends DolibarrModules
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modBoutique($DB)
 	{

htdocs/includes/modules/modCashDesk.class.php

@@ -32,8 +32,9 @@ include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php");
 class modCashDesk extends DolibarrModules
 {
 	/**
-	 *		\brief	Constructor. Define names, constants, boxes...
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 * 		\param	DB		Database handler
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modCashDesk ($DB)
 	{

htdocs/includes/modules/modCategorie.class.php

@@ -33,8 +33,9 @@ include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php");
 class modCategorie extends DolibarrModules
 {
 	/**
-	 *		\brief	Constructor
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 * 		\param	DB	Database handler
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modCategorie ($DB)
 	{

htdocs/includes/modules/modClickToDial.class.php

@@ -28,16 +28,17 @@ include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php");
 
 
 /**
- \class      modClickToDial
+ *	\class      modClickToDial
- \brief      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
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acc<EFBFBD>s base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modClickToDial($DB)
 	{

htdocs/includes/modules/modCommande.class.php

@@ -39,8 +39,9 @@ class modCommande extends DolibarrModules
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      Database handler
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modCommande($DB)
 	{

htdocs/includes/modules/modComptabilite.class.php

@@ -30,15 +30,16 @@ include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php");
 
 
 /**
-		\class 		modComptabilite
+ *		\class 		modComptabilite
-        \brief      Classe de description et activation du module Comptabilite
+ *      \brief      Classe de description et activation du module Comptabilite
  */
 class modComptabilite extends DolibarrModules
 {
 
    /**
-    *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-    *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
     */
 	function modComptabilite($DB)
 	{

htdocs/includes/modules/modContrat.class.php

@@ -37,8 +37,9 @@ class modContrat extends DolibarrModules
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modContrat($DB)
 	{

htdocs/includes/modules/modDeplacement.class.php

@@ -34,8 +34,9 @@ class modDeplacement extends DolibarrModules
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modDeplacement($DB)
 	{

htdocs/includes/modules/modDocument.class.php

@@ -37,8 +37,9 @@ class modDocument extends DolibarrModules
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modDocument($DB)
 	{

htdocs/includes/modules/modDon.class.php

@@ -36,8 +36,9 @@ class modDon  extends DolibarrModules
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modDon($DB)
 	{

htdocs/includes/modules/modECM.class.php

@@ -33,8 +33,9 @@ class modECM extends DolibarrModules
 {
 
    /**
-    *   \brief      Constructor. Define names, constants, directories, boxes, permissions
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-    *   \param      DB      Database handler
+	 *
+	 *   @param      DoliDB		$DB      Database handler
     */
 	function modECM($DB)
 	{

htdocs/includes/modules/modExpedition.class.php

@@ -37,8 +37,9 @@ class modExpedition extends DolibarrModules
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modExpedition($DB)
 	{

htdocs/includes/modules/modExport.class.php

@@ -28,15 +28,16 @@ include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php");
 
 
 /**     \class      modExport
- \brief      Classe de description et activation du module export
+ *		\brief      Classe de description et activation du module export
  */
 
 class modExport extends DolibarrModules
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modExport($DB)
 	{

htdocs/includes/modules/modExternalRss.class.php

@@ -28,15 +28,16 @@ include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php");
 
 
 /**     \class      modExternalRss
- \brief      Classe de description et activation du module externalrss
+ *		\brief      Classe de description et activation du module externalrss
  */
 
 class modExternalRss extends DolibarrModules
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modExternalRss($DB)
 	{

htdocs/includes/modules/modExternalSite.class.php

@@ -36,8 +36,9 @@ class modExternalSite extends DolibarrModules
 {
 
    /**
-    *   \brief      Constructor. Define names, constants, directories, boxes, permissions
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-    *   \param      DB      Database handler
+	 *
+	 *   @param      DoliDB		$DB      Database handler
     */
 	function modExternalSite($DB)
 	{

htdocs/includes/modules/modFTP.class.php

@@ -34,8 +34,9 @@ class modFTP extends DolibarrModules
 {
 
    /**
-    *   \brief      Constructor. Define names, constants, directories, boxes, permissions
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-    *   \param      DB      Database handler
+	 *
+	 *   @param      DoliDB		$DB      Database handler
     */
 	function modFTP($DB)
 	{

htdocs/includes/modules/modFacture.class.php

@@ -37,8 +37,9 @@ class modFacture extends DolibarrModules
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      Database handler
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modFacture($DB)
 	{

htdocs/includes/modules/modFckeditor.class.php

@@ -36,8 +36,9 @@ include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php");
 class modFckeditor extends DolibarrModules
 {
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modFckeditor($DB)
 	{

htdocs/includes/modules/modFicheinter.class.php

@@ -39,8 +39,9 @@ class modFicheinter  extends DolibarrModules
 {
 
     /**
-     *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-     *   \param      DB      Database access handler
+	 *
+	 *   @param      DoliDB		$DB      Database handler
      */
     function modFicheinter($DB)
     {

htdocs/includes/modules/modFournisseur.class.php

@@ -35,8 +35,9 @@ class modFournisseur extends DolibarrModules
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modFournisseur($DB)
 	{

htdocs/includes/modules/modGeoIPMaxmind.class.php

@@ -33,8 +33,9 @@ class modGeoIPMaxmind extends DolibarrModules
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modGeoIPMaxmind($DB)
 	{

htdocs/includes/modules/modGravatar.class.php

@@ -32,8 +32,9 @@ include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php");
 class modGravatar extends DolibarrModules
 {
 	/**
-	 *   \brief      Constructor. Define names, constants, directories, boxes, permissions
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      Database handler
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modGravatar($DB)
 	{

htdocs/includes/modules/modImport.class.php

@@ -34,8 +34,9 @@ class modImport extends DolibarrModules
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modImport($DB)
 	{

htdocs/includes/modules/modLabel.class.php

@@ -36,8 +36,9 @@ class modLabel extends DolibarrModules
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modLabel($DB)
 	{

htdocs/includes/modules/modLdap.class.php

@@ -34,8 +34,9 @@ include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php");
 class modLdap extends DolibarrModules
 {
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modLdap($DB)
 	{

htdocs/includes/modules/modMailing.class.php

@@ -36,8 +36,9 @@ class modMailing extends DolibarrModules
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modMailing($DB)
 	{

htdocs/includes/modules/modNotification.class.php

@@ -34,8 +34,9 @@ class modNotification extends DolibarrModules
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modNotification($DB)
 	{

htdocs/includes/modules/modPrelevement.class.php

@@ -37,8 +37,9 @@ class modPrelevement extends DolibarrModules
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modPrelevement($DB)
 	{

htdocs/includes/modules/modProduct.class.php

@@ -37,8 +37,9 @@ include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php");
 class modProduct extends DolibarrModules
 {
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modProduct($DB)
 	{

htdocs/includes/modules/modProjet.class.php

@@ -38,8 +38,9 @@ class modProjet extends DolibarrModules
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modProjet($DB)
 	{

htdocs/includes/modules/modPropale.class.php

@@ -38,8 +38,9 @@ class modPropale extends DolibarrModules
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modPropale($DB)
 	{

htdocs/includes/modules/modService.class.php

@@ -38,8 +38,9 @@ class modService extends DolibarrModules
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modService($DB)
 	{

htdocs/includes/modules/modSociete.class.php

@@ -38,8 +38,9 @@ class modSociete extends DolibarrModules
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modSociete($DB)
 	{

htdocs/includes/modules/modStock.class.php

@@ -36,8 +36,9 @@ class modStock extends DolibarrModules
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modStock($DB)
 	{

htdocs/includes/modules/modSyslog.class.php

@@ -34,8 +34,9 @@ class modSyslog extends DolibarrModules
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modSyslog($DB)
 	{

htdocs/includes/modules/modTax.class.php

@@ -39,8 +39,9 @@ class modTax extends DolibarrModules
 {
 
 	/**
-	 *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modTax($DB)
 	{

htdocs/includes/modules/modUser.class.php

@@ -35,8 +35,9 @@ class modUser extends DolibarrModules
 {
 
 	/**
-	 *   Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-	 *   @param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
 	 */
 	function modUser($DB)
 	{
@@ -134,7 +135,7 @@ class modUser extends DolibarrModules
 		$this->rights[$r][1] = 'Consulter ses propres permissions';
 		$this->rights[$r][2] = 'r';
 		$this->rights[$r][3] = 1;
-		$this->rights[$r][4] = 'self_advance';
+		$this->rights[$r][4] = 'self_advance';        // Visible if option MAIN_USE_ADVANCED_PERMS is on
 		$this->rights[$r][5] = 'readperms';
 
 		$r++;
@@ -226,6 +227,7 @@ class modUser extends DolibarrModules
      *      Function called when module is enabled.
      *      The init function add constants, boxes, permissions and menus (defined in constructor) into Dolibarr database.
      *      It also creates data directories.
+     *
      *      @return     int             1 if OK, 0 if KO
      */
 	function init()
@@ -244,6 +246,7 @@ class modUser extends DolibarrModules
      *      Function called when module is disabled.
      *      Remove from database constants, boxes and permissions from Dolibarr database.
      *      Data directories are not deleted.
+     *
      *      @return     int             1 if OK, 0 if KO
      */
 	function remove()

htdocs/includes/modules/modWebServices.class.php

@@ -34,8 +34,9 @@ class modWebServices extends DolibarrModules
 {
 
     /**
-     *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-     *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
      */
     function modWebServices($DB)
     {

htdocs/includes/modules/modWorkflow.class.php

@@ -35,8 +35,9 @@ class modWorkflow extends DolibarrModules
 {
 
     /**
-     *   \brief      Constructeur. Definit les noms, constantes et boites
+	 *   Constructor. Define names, constants, directories, boxes, permissions
-     *   \param      DB      handler d'acces base
+	 *
+	 *   @param      DoliDB		$DB      Database handler
      */
     function modWorkflow($DB)
     {