Doxygen

htdocs/core/class/dolgraph.class.php

@@ -19,6 +19,7 @@
 
 /**
  *	\file       htdocs/core/class/dolgraph.class.php
+ *  \ingroup    core
  *	\brief      Fichier de la classe mere de gestion des graph
  *	\version    $Id$
  *

htdocs/core/class/html.form.class.php

@@ -28,6 +28,7 @@
 
 /**
  *	\file       htdocs/core/class/html.form.class.php
+ *  \ingroup    core
  *	\brief      File of class with all html predefined components
  *	\version	$Id$
  */

htdocs/core/class/html.formactions.class.php

@@ -17,16 +17,17 @@
  */
 
 /**
-        \file       htdocs/core/class/html.formactions.class.php
+ *      \file       htdocs/core/class/html.formactions.class.php
-        \brief      Fichier de la classe des fonctions predefinie de composants html actions
+ *      \ingroup    core
-		\version	$Id$
+ *      \brief      Fichier de la classe des fonctions predefinie de composants html actions
-*/
+ *		\version	$Id$
+ */
 
 
 /**
-        \class      FormActions
+ *      \class      FormActions
-        \brief      Classe permettant la generation de composants html actions
+ *      \brief      Classe permettant la generation de composants html actions
-*/
+ */
 class FormActions
 {
     var $db;

htdocs/core/class/html.formadmin.class.php

@@ -19,6 +19,7 @@
 
 /**
  *      \file       htdocs/core/class/html.formadmin.class.php
+ *      \ingroup    core
  *      \brief      File of class for html functions for admin pages
  *		\version	$Id$
  */

htdocs/core/class/html.formcompany.class.php

@@ -18,6 +18,7 @@
 
 /**
  *	\file       htdocs/core/class/html.formcompany.class.php
+ *  \ingroup    core
  *	\brief      File of class to build HTML component for third parties management
  *	\version	$Id$
  */

htdocs/core/class/html.formfile.class.php

@@ -19,6 +19,7 @@
 
 /**
  *	\file       htdocs/core/class/html.formfile.class.php
+ *  \ingroup    core
  *	\brief      File of class to offer components to list and upload files
  *	\version	$Id$
  */

htdocs/core/class/html.formmail.class.php

@@ -19,10 +19,10 @@
 
 /**
  *       \file       htdocs/core/class/html.formmail.class.php
+ *       \ingroup    core
  *       \brief      Fichier de la classe permettant la generation du formulaire html d'envoi de mail unitaire
  *       \version    $Id$
  */
-
 require_once(DOL_DOCUMENT_ROOT ."/core/class/html.form.class.php");
 
 

htdocs/core/class/html.formorder.class.php

@@ -18,6 +18,7 @@
 
 /**
  *	\file       htdocs/core/class/html.formorder.class.php
+ *  \ingroup    core
  *	\brief      File of predefined functions for HTML forms for order module
  *	\version	$Id$
  */

htdocs/core/class/html.formother.class.php

@@ -27,6 +27,7 @@
 
 /**
  *	\file       htdocs/core/class/html.formother.class.php
+ *  \ingroup    core
  *	\brief      Fichier de la classe des fonctions predefinie de composants html autre
  *	\version	$Id$
  */

htdocs/core/class/interfaces.class.php

@@ -20,7 +20,7 @@
 
 /**
  *   \file		    htdocs/core/class/interfaces.class.php
- *   \ingroup		workflow
+ *   \ingroup		core
  *   \brief			Fichier de la classe de gestion des triggers
  *   \version		$Id$
  */

htdocs/core/class/menu.class.php

@@ -19,6 +19,7 @@
 
 /**
  *  \file       htdocs/core/class/menu.class.php
+ *  \ingroup    core
  *  \brief      Fichier de la classe de gestion du menu gauche
  *  \version    $Id$
  */

htdocs/core/class/notify.class.php

@@ -18,18 +18,18 @@
  */
 
 /**
-        \file       htdocs/core/class/notify.class.php
+ *      \file       htdocs/core/class/notify.class.php
-        \brief      Fichier de la classe de gestion des notifications
+ *      \ingroup    core
-        \version    $Id$
+ *      \brief      Fichier de la classe de gestion des notifications
-*/
+ *      \version    $Id$
+ */
 require_once(DOL_DOCUMENT_ROOT ."/lib/CMailFile.class.php");
 
 
 /**
-        \class      Notify
+ *      \class      Notify
-        \brief      Classe de gestion des notifications
+ *      \brief      Classe de gestion des notifications
-*/
+ */
-
 class Notify
 {
     var $id;

htdocs/core/class/smartphone.class.php

@@ -18,6 +18,7 @@
 
 /**
  *  \file       htdocs/core/class/smartphone.class.php
+ *  \ingroup    core
  *  \brief      Fichier de la classe de gestion des smartphones
  *  \version    $Id$
  */

htdocs/core/class/translate.class.php

@@ -20,6 +20,7 @@
 
 /**
  *   	\file       htdocs/core/class/translate.class.php
+ *      \ingroup    core
  *		\brief      File for Tanslate class
  *		\author	    Eric Seigne
  *		\author	    Laurent Destailleur
@@ -126,16 +127,16 @@ class Translate {
 
 
 	/**
-	 *  \brief      Load translation key-value for a particular file, into a memory array.
+	 *  Load translation key-value for a particular file, into a memory array.
 	 *  If data for file already loaded, do nothing.
 	 * 	All data in translation array are stored in UTF-8 format.
-	 *  \param      domain      		File name to load (.lang file). Use file@module if file is in a module directory.
+     *  tab_loaded is completed with $domain key.
-	 *  \param      alt         		0 (try xx_ZZ then 1), 1 (try xx_XX then 2), 2 (try en_US or fr_FR or es_ES)
-	 * 	\param		stopafterdirection	Stop when the DIRECTION tag is found (optimize)
-	 * 	\param		forcelangdir		To force a lang directory
-	 *	\return		int					<0 if KO, 0 if already loaded, >0 if OK
-	 *	\remarks	tab_loaded is completed with $domain key.
      *              Value for hash are: 1:Loaded from disk, 2:Not found, 3:Loaded from cache
+	 *  @param      domain      		File name to load (.lang file). Use file@module if file is in a module directory.
+	 *  @param      alt         		0 (try xx_ZZ then 1), 1 (try xx_XX then 2), 2 (try en_US or fr_FR or es_ES)
+	 * 	@param		stopafterdirection	Stop when the DIRECTION tag is found (optimize)
+	 * 	@param		forcelangdir		To force a lang directory
+	 *	@return		int					<0 if KO, 0 if already loaded, >0 if OK
 	 */
 	function Load($domain,$alt=0,$stopafterdirection=0,$forcelangdir='')
 	{
@@ -518,6 +519,7 @@ class Translate {
 	/**
 	 *  Return list of all available languages
 	 * 	@param		langdir		Directory to scan
+	 *  @param      maxlength   Max length for each value in combo box (will be truncated)
 	 *  @return     array     	List of languages
 	 */
 	function get_available_languages($langdir=DOL_DOCUMENT_ROOT,$maxlength=0)

htdocs/societe/class/societe.class.php

@@ -1125,11 +1125,12 @@ class Societe extends CommonObject
     }
 
     /**
-     *    	\brief      Add a discount for third party
+     *    	Add a discount for third party
-     *    	\param      remise      Montant de la remise
+     *    	@param      remise      Montant de la remise
-     *    	\param      user        Utilisateur qui accorde la remise
+     *    	@param      user        Utilisateur qui accorde la remise
-     *    	\param      desc		Motif de l'avoir
+     *    	@param      desc		Motif de l'avoir
-     *		\return		int			<0 si ko, id de la ligne de remise si ok
+     *      @param      tva_tx      VAT rate
+     *		@return		int			<0 if KO, id or record if OK
      */
     function set_remise_except($remise, $user, $desc, $tva_tx=0)
     {
@@ -1887,8 +1888,8 @@ class Societe extends CommonObject
     }
 
     /**
-     *       \brief     Return if third party is a company (Business) or an end user (Consumer)
+     *       Return if third party is a company (Business) or an end user (Consumer)
-     *       \param     boolean     true=is a company, false=a and user
+     *       @return    boolean     true=is a company, false=a and user
      */
     function isACompany()
     {
@@ -1905,8 +1906,8 @@ class Societe extends CommonObject
 
 
     /**
-     *       \brief     Return if a country is inside the EEC (European Economic Community)
+     *       Return if a country is inside the EEC (European Economic Community)
-     *       \param     boolean		true = pays inside EEC, false= pays outside EEC
+     *       @param     boolean		true = pays inside EEC, false= pays outside EEC
      */
     function isInEEC()
     {
@@ -1949,8 +1950,8 @@ class Societe extends CommonObject
     }
 
     /**
-     *  	\brief     Charge la liste des categories fournisseurs
+     *  Charge la liste des categories fournisseurs
-     *   \return    0 in success, <> 0 in error
+     *  @return    int      0 if success, <> 0 if error
      */
     function LoadSupplierCateg()
     {
@@ -1976,7 +1977,7 @@ class Societe extends CommonObject
 
     /**
      *  Charge la liste des categories fournisseurs
-     *  @return    0 in success, <> 0 in error
+     *  @return    int      0 if success, <> 0 if error
      */
     function AddFournisseurInCategory($categorie_id)
     {
@@ -2063,10 +2064,10 @@ class Societe extends CommonObject
     }
 
     /**
-     *      \brief      Cree en base un tiers depuis l'objet adherent
+     *      Cree en base un tiers depuis l'objet adherent
-     *      \param      member		Objet adherent source
+     *      @param      member		Objet adherent source
-     * 		\param		socname		Name of third to force
+     * 		@param		socname		Name of third to force
-     *      \return     int			Si erreur <0, si ok renvoie id compte cree
+     *      @return     int			Si erreur <0, si ok renvoie id compte cree
      */
     function create_from_member($member,$socname='')
     {