Doxygen

htdocs/adherents/class/adherent.class.php

@@ -24,7 +24,7 @@
 /**
  *	\file       htdocs/adherents/class/adherent.class.php
  *	\ingroup    member
- *	\brief      Fichier de la classe permettant la gestion d'un adherent
+ *	\brief      File of class to manage members of a foundation
  *	\version    $Id$
  */
 
@@ -36,7 +36,7 @@ require_once(DOL_DOCUMENT_ROOT."/lib/date.lib.php");
 
 /**
  *      \class      Adherent
- *		\brief      Classe permettant la gestion d'un adherent
+ *		\brief      Class to manage members of a foundation
  */
 class Adherent extends CommonObject
 {

htdocs/adherents/class/adherent_options.class.php

@@ -24,13 +24,13 @@
 /**
  * 	\file 		htdocs/adherents/class/adherent_options.class.php
  *	\ingroup    member
- *	\brief      Fichier de la classe de gestion de la table des champs optionels adherents
+ *	\brief      File of class to manage optionnal fields
  *	\version    $Id$
  */
 
 /**
  * 	\class 		AdherentOptions
- *	\brief      Classe de gestion de la table des champs optionels adherents
+ *	\brief      Class to manage table of optionnal fields
  */
 class AdherentOptions
 {
@@ -156,9 +156,9 @@ class AdherentOptions
 	}
 
 	/**
-	 *	\brief 		Fonction qui supprime un attribut
+	 *	Fonction qui supprime un attribut
-	 *	\param		attrname			nom de l'atribut
+	 *	@param		$attrname			nom de l'atribut
-	 *  \TODO pouvoir gerer les entités
+	 *  TODO pouvoir gerer les entités
 	 */
 	function delete($attrname)
 	{

htdocs/adherents/class/adherent_type.class.php

@@ -21,7 +21,7 @@
 /**
  *	\file       htdocs/adherents/class/adherent_type.class.php
  *	\ingroup    member
- *	\brief      Fichier de la classe gerant les types d'adherents
+ *	\brief      File of class to manage members types
  *	\author     Rodolphe Quiedeville
  *	\version    $Id$
  */
@@ -31,7 +31,7 @@ require_once(DOL_DOCUMENT_ROOT."/core/class/commonobject.class.php");
 
 /**
  *	\class      AdherentType
- *	\brief      Classe gerant les types d'adherents
+ *	\brief      Class to manage members type
  */
 class AdherentType extends CommonObject
 {

htdocs/adherents/class/cotisation.class.php

@@ -20,7 +20,7 @@
 /**
  *		\file 		htdocs/adherents/class/cotisation.class.php
  *      \ingroup    member
- *		\brief      File of class to manage subscriptions
+ *		\brief      File of class to manage subscriptions of foundation members
  *		\version    $Id$
  */
 
@@ -29,7 +29,7 @@ require_once(DOL_DOCUMENT_ROOT."/core/class/commonobject.class.php");
 
 /**
  *	\class 		Cotisation
- *	\brief      Class to manage subscriptions
+ *	\brief      Class to manage subscriptions of foundation members
  */
 class Cotisation extends CommonObject
 {

htdocs/admin/commande.php

@@ -141,7 +141,7 @@ if ($_GET["action"] == 'setdoc')
 
 if ($_GET["action"] == 'setmod')
 {
-	// \todo Verifier si module numerotation choisi peut etre active
+	// TODO Verifier si module numerotation choisi peut etre active
 	// par appel methode canBeActivated
 
 	dolibarr_set_const($db, "COMMANDE_ADDON",$_GET["value"],'chaine',0,'',$conf->entity);

htdocs/admin/fichinter.php

@@ -155,7 +155,7 @@ if ($_GET["action"] == 'setdoc')
 
 if ($_GET["action"] == 'setmod')
 {
-	// \todo Verifier si module numerotation choisi peut etre active
+	// TODO Verifier si module numerotation choisi peut etre active
 	// par appel methode canBeActivated
 
 	dolibarr_set_const($db, "FICHEINTER_ADDON",$_GET["value"],'chaine',0,'',$conf->entity);

htdocs/admin/fournisseur.php

@@ -126,7 +126,6 @@ if ($_GET["action"] == 'specimenfacture')
 
 if ($_GET["action"] == 'set')
 {
-	$type='supplier_order';
 	$sql = "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES ('".$_GET["value"]."','".$_GET["type"]."',".$conf->entity.")";
 	if ($db->query($sql))
 	{
@@ -181,7 +180,7 @@ if ($_GET["action"] == 'setdoc')
 
 if ($_GET["action"] == 'setmod')
 {
-	// \todo Verifier si module numerotation choisi peut etre active
+	// TODO Verifier si module numerotation choisi peut etre active
 	// par appel methode canBeActivated
 
 	dolibarr_set_const($db, "COMMANDE_SUPPLIER_ADDON",$_GET["value"],'chaine',0,'',$conf->entity);

htdocs/admin/livraison.php

@@ -146,7 +146,7 @@ if ($_POST["action"] == 'set_DELIVERY_FREE_TEXT')
 
 if ($_GET["action"] == 'setmod')
 {
-    // \todo Verifier si module numerotation choisi peut etre active
+    // TODO Verifier si module numerotation choisi peut etre active
     // par appel methode canBeActivated
 
 	dolibarr_set_const($db, "LIVRAISON_ADDON",$_GET["value"],'chaine',0,'',$conf->entity);

htdocs/admin/project.php

@@ -135,7 +135,7 @@ if ($_GET["action"] == 'setdoc')
 
 if ($_GET["action"] == 'setmod')
 {
-	// \todo Verifier si module numerotation choisi peut etre active
+	// TODO Verifier si module numerotation choisi peut etre active
 	// par appel methode canBeActivated
 
 	dolibarr_set_const($db, "PROJECT_ADDON",$_GET["value"],'chaine',0,'',$conf->entity);

htdocs/admin/propale.php

@@ -168,7 +168,7 @@ if ($_GET["action"] == 'setdoc')
 
 if ($_GET["action"] == 'setmod')
 {
-	// \todo Verifier si module numerotation choisi peut etre active
+	// TODO Verifier si module numerotation choisi peut etre active
 	// par appel methode canBeActivated
 
 	dolibarr_set_const($db, "PROPALE_ADDON",$_GET["value"],'chaine',0,'',$conf->entity);

htdocs/bookmarks/class/bookmark.class.php

@@ -19,16 +19,15 @@
 /**
  *      \file       htdocs/bookmarks/class/bookmark.class.php
  *      \ingroup    bookmark
- *      \brief      File the bookmark class
+ *      \brief      File of class to manage bookmarks
  *      \version    $Id$
  */
 
 
 /**
  *		\class      Bookmark
- *		\brief      Class for managing bookmarks
+ *		\brief      Class to manage bookmarks
  */
-
 class Bookmark
 {
     var $db;

htdocs/categories/class/categorie.class.php

@@ -24,7 +24,7 @@
 /**
  *	\file       htdocs/categories/class/categorie.class.php
  *	\ingroup    categorie
- *	\brief      Fichier de la classe des categorie
+ *	\brief      File of class to manage categories
  *	\version	$Id$
  */
 
@@ -34,7 +34,7 @@ require_once(DOL_DOCUMENT_ROOT."/fourn/class/fournisseur.class.php");
 
 /**
  *	\class      Categorie
- *	\brief      Classe permettant la gestion des categories
+ *	\brief      Class to manage categories
  */
 class Categorie
 {

htdocs/comm/action/class/actioncomm.class.php

@@ -21,7 +21,7 @@
 /**
  *       \file       htdocs/comm/action/class/actioncomm.class.php
  *       \ingroup    commercial
- *       \brief      Fichier de la classe des actions commerciales
+ *       \brief      File of class to manage agenda events (actions)
  *       \version    $Id$
  */
 require_once(DOL_DOCUMENT_ROOT.'/comm/action/class/cactioncomm.class.php');
@@ -29,7 +29,7 @@ require_once(DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php');
 
 
 /**     \class      ActionComm
- *	    \brief      Classe permettant la gestion des actions commerciales
+ *	    \brief      Class to manage agenda events (actions)
  */
 class ActionComm extends CommonObject
 {

htdocs/comm/action/class/cactioncomm.class.php

@@ -20,7 +20,7 @@
 /**
  *       \file       htdocs/comm/action/class/cactioncomm.class.php
  *       \ingroup    commercial
- *       \brief      Fichier de la classe des types d'actions commerciales
+ *       \brief      File of class to manage type of agenda events
  *       \version    $Id$
 */
 

htdocs/comm/index.php

@@ -481,7 +481,7 @@ if ($user->rights->agenda->myactions->read)
  * Derniers contrats
  *
  */
-if ($conf->contrat->enabled && $user->rights->contrat->lire && 0) // \todo A REFAIRE DEPUIS NOUVEAU CONTRAT
+if ($conf->contrat->enabled && $user->rights->contrat->lire && 0) // TODO A REFAIRE DEPUIS NOUVEAU CONTRAT
 {
 	$langs->load("contracts");
 

htdocs/comm/propal/class/propal.class.php

@@ -145,12 +145,12 @@ class Propal extends CommonObject
 
 
 	/**
-	 * 	\brief     	Ajoute une ligne dans tableau products
+	 * 	Add line into array products
-	 * 	\param     	idproduct       	Id du produit a ajouter
+	 *	$this->client doit etre charge
-	 * 	\param     	qty             	Quantity
+	 * 	@param     	idproduct       	Id du produit a ajouter
-	 * 	\param     	remise_percent  	Remise relative effectuee sur le produit
+	 * 	@param     	qty             	Quantity
-	 *	\remarks	$this->client doit etre charge
+	 * 	@param      remise_percent  	Remise relative effectuee sur le produit
-	 *	\TODO	Remplacer les appels a cette fonction par generation objet Ligne
+	 *	TODO	Remplacer les appels a cette fonction par generation objet Ligne
 	 *			insere dans tableau $this->products
 	 */
 	function add_product($idproduct, $qty, $remise_percent=0)

htdocs/commande/class/commande.class.php

@@ -853,7 +853,7 @@ class Commande extends CommonObject
 				$rangtouse = $rangmax + 1;
 			}
 
-			// \TODO A virer
+			// TODO A virer
 			// Anciens indicateurs: $price, $remise (a ne plus utiliser)
 			$price = $pu;
 			$remise = 0;
@@ -889,7 +889,7 @@ class Commande extends CommonObject
 			$this->line->date_start=$date_start;
 			$this->line->date_end=$date_end;
 
-			// \TODO Ne plus utiliser
+			// TODO Ne plus utiliser
 			$this->line->price=$price;
 			$this->line->remise=$remise;
 
@@ -897,7 +897,7 @@ class Commande extends CommonObject
 			if ($result > 0)
 			{
 				// Mise a jour informations denormalisees au niveau de la commande meme
-				$this->id=$commandeid;	// \TODO A virer
+				$this->id=$commandeid;	// TODO A virer
 				$result=$this->update_price($commandeid);
 				if ($result > 0)
 				{
@@ -922,15 +922,15 @@ class Commande extends CommonObject
 
 
 	/**
-	 * 		\brief				Ajoute une ligne dans tableau lines
+	 * 		Add line into array
-	 *		\param				idproduct			Id du produit a ajouter
+	 *		$this->client doit etre charge
-	 *		\param				qty					Quantite
+	 *		@param				idproduct			Id du produit a ajouter
-	 * 		\param    	date_start             	Start date of the line - Added by Matelli (See http://matelli.fr/showcases/patchs-dolibarr/add-dates-in-order-lines.html)
+	 *		@param				qty					Quantite
-	 * 		\param    	date_end             	End date of the line - Added by Matelli (See http://matelli.fr/showcases/patchs-dolibarr/add-dates-in-order-lines.html)
+	 * 		@param    	date_start             	Start date of the line - Added by Matelli (See http://matelli.fr/showcases/patchs-dolibarr/add-dates-in-order-lines.html)
-	 *		\remise_percent		remise_percent		Remise relative effectuee sur le produit
+	 * 		@param    	date_end             	End date of the line - Added by Matelli (See http://matelli.fr/showcases/patchs-dolibarr/add-dates-in-order-lines.html)
-	 * 		\return    			void
+	 *		@remise_percent		remise_percent		Remise relative effectuee sur le produit
-	 *		\remarks			$this->client doit etre charge
+	 * 		@return    			void
-	 *		\TODO	Remplacer les appels a cette fonction par generation objet Ligne
+	 *		TODO	Remplacer les appels a cette fonction par generation objet Ligne
 	 *				insere dans tableau $this->products
 	 */
 	function add_product($idproduct, $qty, $remise_percent=0, $date_start='', $date_end='')

htdocs/compta/bank/account.php

@@ -457,7 +457,7 @@ if ($account || $_GET["ref"])
     }
     if ($mode_search && $conf->adherent->enabled)
     {
-        // \TODO Mettre jointure sur adherent pour recherche sur un adherent
+        // TODO Mettre jointure sur adherent pour recherche sur un adherent
         //$sql.= " LEFT JOIN ".MAIN_DB_PREFIX."bank_url as bu3 ON bu3.fk_bank = b.rowid AND bu3.type='company'";
         //$sql.= " LEFT JOIN ".MAIN_DB_PREFIX."societe as s ON bu3.url_id = s.rowid";
     }

htdocs/compta/bank/class/account.class.php

@@ -1166,7 +1166,7 @@ class AccountLine extends CommonObject
 				}
 
 				$this->date_creation     = $this->db->jdate($obj->datec);
-				//$this->date_rappro       = $obj->daterappro;    // \todo pas encore g<>r<EFBFBD>e
+				//$this->date_rappro       = $obj->daterappro;    // Not yet managed
 			}
 			$this->db->free($result);
 		}

htdocs/compta/bank/treso.php

@@ -257,7 +257,7 @@ if ($_REQUEST["account"] || $_REQUEST["ref"])
 
 			if ($obj->family == 'supplier_invoice')
 			{
-				// \TODO This code is to avoid to count suppliers credit note (ff.type = 2)
+				// TODO This code is to avoid to count suppliers credit note (ff.type = 2)
 				// Ajouter gestion des avoirs fournisseurs, champ
 				if (($obj->total_ttc < 0 && $obj->type != 2)
 				 || ($obj->total_ttc > 0 && $obj->type == 2))

htdocs/compta/deplacement/class/deplacement.class.php

@@ -65,9 +65,9 @@ class Deplacement extends CommonObject
 	/**
 	 * Create object in database
 	 *
-	 * @param 	$user	User that creat
+	 * @param 	$user	User that creates
 	 * @return 	int		<0 if KO, >0 if OK
-	 * @TODO Add ref number
+	 * TODO Add ref number
 	 */
 	function create($user)
 	{

htdocs/compta/facture.php

@@ -1415,13 +1415,12 @@ if ($_GET['action'] == 'create')
 	print '<tr><td>'.$langs->trans('Ref').'</td><td colspan="2">'.$langs->trans('Draft').'</td></tr>';
 
 	/*
-	 \todo
 	 L'info "Reference commande client" est une carac de la commande et non de la facture.
 	 Elle devrait donc etre stockee sur l'objet commande liee a la facture et non sur la facture.
 	 Pour ceux qui veulent l'utiliser au niveau de la facture, positionner la
 	 constante FAC_USE_CUSTOMER_ORDER_REF a 1.
 	 */
-	if ($conf->global->FAC_USE_CUSTOMER_ORDER_REF)
+	if ($conf->global->FAC_USE_CUSTOMER_ORDER_REF)	// deprecated
 	{
 		print '<tr><td>'.$langs->trans('RefCustomerOrder').'</td><td>';
 		print '<input type="text" name="ref_client" value="'.$ref_client.'">';
@@ -2148,12 +2147,11 @@ else
 
 			// Ref client
 			/*
-			\todo
 			L'info "Reference commande client" est une carac de la commande et non de la facture.
 			Elle devrait donc etre stockee sur l'objet commande lie a la facture et non sur la facture.
 			Pour ceux qui utilisent ainsi, positionner la constante FAC_USE_CUSTOMER_ORDER_REF a 1.
 			*/
-			if ($conf->global->FAC_USE_CUSTOMER_ORDER_REF)
+			if ($conf->global->FAC_USE_CUSTOMER_ORDER_REF)	// deprecated
 			{
 				print '<tr><td>';
 				print '<table class="nobordernopadding" width="100%"><tr><td nowrap="nowrap">';

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

@@ -222,11 +222,11 @@ class Form
     }
 
     /**
-     *    \brief     Return combo list of activated countries, into language of user
+     *    Return combo list of activated countries, into language of user
-     *    \param     selected         Id or Code or Label of preselected country
+     *    @param     selected         Id or Code or Label of preselected country
-     *    \param     htmlname         Name of html select object
+     *    @param     htmlname         Name of html select object
-     *    \param     htmloption       Options html on select object
+     *    @param     htmloption       Options html on select object
-     *    \TODO      trier liste sur noms apres traduction plutot que avant
+     *    TODO       trier liste sur noms apres traduction plutot que avant
      */
     function select_pays($selected='',$htmlname='pays_id',$htmloption='')
     {
@@ -234,11 +234,11 @@ class Form
     }
 
     /**
-     *    \brief     Return combo list of activated countries, into language of user
+     *    Return combo list of activated countries, into language of user
-     *    \param     selected         Id or Code or Label of preselected country
+     *    @param     selected         Id or Code or Label of preselected country
-     *    \param     htmlname         Name of html select object
+     *    @param     htmlname         Name of html select object
-     *    \param     htmloption       Options html on select object
+     *    @param     htmloption       Options html on select object
-     *    \TODO      trier liste sur noms apres traduction plutot que avant
+     *    TODO       trier liste sur noms apres traduction plutot que avant
      */
     function select_country($selected='',$htmlname='pays_id',$htmloption='')
     {
@@ -398,12 +398,12 @@ class Form
 
     /**
      *		Return list of types of lines (product or service)
+     * 		Example: 0=product, 1=service, 9=other (for external module)
      *		@param      selected        Preselected type
      *		@param      htmlname        Name of field in html form
      * 		@param		showempty		Add an empty field
      * 		@param		hidetext		Do not show label before combo box
      * 		@param		forceall		Force to show products and services in combo list, whatever are activated modules
-     * 		@example	0=product, 1=service, 9=other (for external module)
      */
     function select_type_of_lines($selected='',$htmlname='type',$showempty=0,$hidetext=0,$forceall=0)
     {

htdocs/lib/CMailFile.class.php

@@ -794,17 +794,7 @@ class CMailFile
 	 */
 	function server_parse($socket, $response)
 	{
-		/**
+		$_retVal = true;	// Indicates if Object was created or not
-		 * Default return value
-		 *
-		 * Returns constructed SELECT Object string or boolean upon failure
-		 * Default value is set at TRUE
-		 *
-		 * @var mixed $_retVal Indicates if Object was created or not
-		 * @access private
-		 * @static
-		 */
-		$_retVal = true;
 		$server_response = '';
 
 		while ( substr($server_response,3,1) != ' ' )

htdocs/societe/class/address.class.php

@@ -28,7 +28,7 @@
 
 /**
  *  \class 		Address
- *  \brief 		Classe permettant la gestion des adresses des tiers
+ *  \brief 		Class to manage addresses
  */
 class Address
 {

htdocs/user/class/user.class.php

@@ -33,7 +33,7 @@ require_once(DOL_DOCUMENT_ROOT ."/core/class/commonobject.class.php");
 
 /**
  *	\class      User
- *	\brief      Classe permettant la gestion d'un utilisateur
+ *	\brief      Class to manage users
  */
 class User extends CommonObject
 {

scripts/banks/build-graph-sold-example.php

@@ -158,7 +158,7 @@ foreach ($accounts as $account)
 //	print strftime("%Y%m%d",$max);
 
 	// Chargement du tableau $amounts
-	// \todo peut etre optimise en virant les date_format
+	// TODO peut etre optimise en virant les date_format
 	$amounts = array();
 	$sql = "SELECT date_format(datev,'%Y%m%d'), sum(amount)";
 	$sql .= " FROM ".MAIN_DB_PREFIX."bank";
@@ -252,7 +252,7 @@ foreach ($accounts as $account)
 
 
 	// Chargement du tableau $amounts
-	// \todo peut etre optimise en virant les date_format
+	// TODO peut etre optimise en virant les date_format
 	$amounts = array();
 	$sql = "SELECT date_format(datev,'%Y%m%d'), sum(amount)";
 	$sql .= " FROM ".MAIN_DB_PREFIX."bank";
@@ -346,7 +346,7 @@ foreach ($accounts as $account)
 
 
 	// Chargement du tableau $amounts
-	// \todo peut etre optimise en virant les date_format
+	// TODO peut etre optimise en virant les date_format
 	$amounts = array();
 	$sql = "SELECT date_format(datev,'%Y%m%d'), sum(amount)";
 	$sql .= " FROM ".MAIN_DB_PREFIX."bank";