Doxygen

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

@@ -39,12 +39,12 @@ class Account extends CommonObject
     public $table_element='bank_account';
 
     /**
-     * //TODO: Discuss this. $rowid is preferred over $id
+     * @var	int		Use id instead of rowid
-     * @var
      * @deprecated
      */
     var $rowid;
     var $id;
+
     var $ref;
     var $label;
     //! 1=Compte courant/check/carte, 2=Compte liquide, 0=Compte épargne

htdocs/contrat/class/contrat.class.php

@@ -89,23 +89,7 @@ class Contrat extends CommonObject
 	var $product;
 
 	/**
-	 * TODO: Which is the correct one?
+	 * @var int		Id of user author of the contract
-	 * Author of the contract
-	 * @var
-	 */
-	var $user_author;
-
-	/**
-	 * TODO: Which is the correct one?
-	 * Author of the contract
-	 * @var User
-	 */
-	public $user_creation;
-
-	/**
-	 * TODO: Which is the correct one?
-	 * Author of the contract
-	 * @var int
 	 */
 	public $fk_user_author;
 
@@ -117,38 +101,37 @@ class Contrat extends CommonObject
 	public $user_author_id;
 
 	/**
-	 * @var User
+	 * @var User 	Object user that create the contract. Set by the info method.
+	 */
+	public $user_creation;
+
+	/**
+	 * @var User 	Object user that close the contract. Set by the info method.
 	 */
 	public $user_cloture;
 
 	/**
-	 * Date of creation
+	 * @var int		Date of creation
-	 * @var int
 	 */
 	var $date_creation;
 
 	/**
-	 * Date of last modification
+	 * @var int		Date of last modification. Not filled until you call ->info()
-	 * Not filled until you call ->info()
-	 * @var int
 	 */
 	public $date_modification;
 
 	/**
-	 * Date of validation
+	 * @var int		Date of validation
-	 * @var int
 	 */
 	var $date_validation;
 
 	/**
-	 * Date when contract was signed
+	 * @var int		Date when contract was signed
-	 * @var int
 	 */
 	var $date_contrat;
 
 	/**
-	 * Date of contract closure
+	 * @var int		Date of contract closure
-	 * @var int
 	 * @deprecated we close contract lines, not a contract
 	 */
 	var $date_cloture;
@@ -157,21 +140,15 @@ class Contrat extends CommonObject
 	var $commercial_suivi_id;
 
 	/**
-	 * @deprecated Use note_private or note_public instead
+	 * @var string	Private note
-	 */
-	var $note;
-
-	/**
-	 * Private note
-	 * @var string
 	 */
 	var $note_private;
 
 	/**
-	 * Public note
+	 * @var string	Public note
-	 * @var string
 	 */
 	var $note_public;
+
 	var $modelpdf;
 
 	/**
@@ -184,8 +161,7 @@ class Contrat extends CommonObject
 	var $extraparams=array();
 
 	/**
-	 * Contract lines
+	 * @var ContratLigne[]		Contract lines
-	 * @var ContratLigne[]
 	 */
 	var $lines=array();
 
@@ -569,7 +545,6 @@ class Contrat extends CommonObject
 				$this->commercial_signature_id	= $result["fk_commercial_signature"];
 				$this->commercial_suivi_id		= $result["fk_commercial_suivi"];
 
-				$this->note						= $result["note_private"];	// deprecated
 				$this->note_private				= $result["note_private"];
 				$this->note_public				= $result["note_public"];
 				$this->modelpdf					= $result["model_pdf"];
@@ -726,7 +701,7 @@ class Contrat extends CommonObject
 				// Retreive all extrafield for propal
 				// fetch optionals attributes and labels
 				$line->fetch_optionals($line->id,$extralabelsline);
-				
+
 				$this->lines[]			= $line;
 
 				//dol_syslog("1 ".$line->desc);
@@ -822,13 +797,13 @@ class Contrat extends CommonObject
 				if ($line->statut == 4 && (! empty($line->date_fin_prevue) && $line->date_fin_prevue < $now)) $this->nbofservicesexpired++;
 				if ($line->statut == 5) $this->nbofservicesclosed++;
 
-				
+
 				// Retreive all extrafield for propal
 				// fetch optionals attributes and labels
-				
+
 				$line->fetch_optionals($line->id,$extralabelsline);
-			
+
-				
+
 				$this->lines[]        = $line;
 
 				$total_ttc+=$objp->total_ttc;

htdocs/core/modules/modAskPriceSupplier.class.php

@@ -21,7 +21,7 @@
  */
 
 /**
- *	\defgroup   askpricesupplier     Module to request supplier price proposals
+ *	\defgroup   askpricesupplier     Module askpricesupplier
  *	\brief      Module to request supplier price proposals
  *	\file       htdocs/core/modules/modAskPriceSupplier.class.php
  *	\ingroup    askpricesupplier

htdocs/core/modules/modExpenseReport.class.php

@@ -17,14 +17,13 @@
  */
 
 /**
- * 		\defgroup   Indicateurs
+ * 		\defgroup   expensereport	Module expensereport
- *      \brief      Module indicateurs
+ *      \brief      Module to manage expense report. Replace old module Deplacement.
- *					Such a file must be copied into htdocs/includes/module directory.
  */
 
 /**
- *      \file       htdocs/indicateurs/core/modules/modExpenseReport.class.php
+ *      \file       htdocs/core/modules/modExpenseReport.class.php
- *      \ingroup    indicateur
+ *      \ingroup    expensereport
  *      \brief      Description and activation file for module ExpenseReport
  */
 include_once(DOL_DOCUMENT_ROOT ."/core/modules/DolibarrModules.class.php");

htdocs/core/modules/modFTP.class.php

@@ -17,7 +17,7 @@
  */
 
 /**
- * 		\defgroup   ftp		Module FTP
+ * 		\defgroup   ftp		Module ftp
  * 		\brief      Module for FTP client module
  *      \file       htdocs/core/modules/modFTP.class.php
  *      \ingroup    ftp

htdocs/core/modules/modFicheinter.class.php

@@ -21,7 +21,7 @@
  */
 
 /**
- *	\defgroup   ficheinter     Module intervention cards
+ *	\defgroup   ficheinter     Module Interventions
  *	\brief      Module to manage intervention cards
  *	\file       htdocs/core/modules/modFicheinter.class.php
  *	\ingroup    ficheinter

htdocs/core/modules/modGeoIPMaxmind.class.php

@@ -16,7 +16,7 @@
  */
 
 /**
- *  \defgroup   geoip      Module GeoIP
+ *  \defgroup   geoip      Module geoipmaxmind
  *  \brief      Module to make geoip conversions
  *	\file       htdocs/core/modules/modGeoIPMaxmind.class.php
  *	\ingroup    geoip

htdocs/core/modules/modResource.class.php

@@ -17,7 +17,7 @@
  */
 
 /**
- * 	\defgroup	resource	Resource module
+ * 	\defgroup	resource	Module resource
  * 	\brief		Resource module descriptor.
  * 	\file		core/modules/modResource.class.php
  * 	\ingroup	resource

htdocs/expensereport/ajax/ajaxprojet.php

@@ -20,6 +20,7 @@
 
 /**
  *       \file       htdocs/expensereport/ajax/ajaxprojet.php
+ *       \ingroup    expensereport
  *       \brief      File to return Ajax response on third parties request
  */
 

htdocs/expensereport/card.php

@@ -19,7 +19,8 @@
 
 /**
  *  \file       	htdocs/expensereport/card.php
- *  \brief      	Page for trip and expense card
+ *  \ingroup    	expensereport
+ *  \brief      	Page for trip and expense report card
  */
 
 $res=0;
@@ -1135,7 +1136,7 @@ if ($action == 'create')
 		print '</td>';
 		print '</tr>';
 	}
-	
+
 	// Public note
 	print '<tr>';
 	print '<td class="border" valign="top">' . $langs->trans('NotePublic') . '</td>';
@@ -1155,7 +1156,7 @@ if ($action == 'create')
 		print $doleditor->Create(1);
 		print '</td></tr>';
 	}
-	
+
 	print '<tbody>';
 	print '</table>';
 
@@ -1286,7 +1287,7 @@ else
 					print '</td></tr>';
 
 				}
-				
+
 				// Public note
 				print '<tr>';
 				print '<td class="border" valign="top">' . $langs->trans('NotePublic') . '</td>';
@@ -1295,7 +1296,7 @@ else
 				$doleditor = new DolEditor('note_public', $object->note_public, '', 80, 'dolibarr_notes', 'In', 0, false, true, ROWS_3, 70);
 				print $doleditor->Create(1);
 				print '</td></tr>';
-				
+
 				// Private note
 				if (empty($user->societe_id)) {
 					print '<tr>';
@@ -1306,7 +1307,7 @@ else
 					print $doleditor->Create(1);
 					print '</td></tr>';
 				}
-				
+
 				print '</table>';
 
 				dol_fiche_end();

htdocs/expensereport/class/expensereport.class.php

@@ -16,6 +16,11 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ *       \file       htdocs/expensereport/class/expensereport.class.php
+ *       \ingroup    expensereport
+ *       \brief      File to manage Expense Reports
+ */
 require_once DOL_DOCUMENT_ROOT .'/core/class/commonobject.class.php';
 
 /**
@@ -1420,7 +1425,7 @@ class ExpenseReport extends CommonObject
 
 		return $this->commonGenerateDocument($modelpath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref);
 	}
-	
+
 	/**
 	 * List of types
 	 *

htdocs/expensereport/class/expensereportstats.class.php

@@ -19,7 +19,7 @@
 
 /**
  *       \file       htdocs/expensereport/class/expensereportstats.class.php
- *       \ingroup    ExpenseReport
+ *       \ingroup    expensereport
  *       \brief      Fichier de la classe de gestion des stats des expensereport et notes de frais
  */
 include_once DOL_DOCUMENT_ROOT . '/core/class/stats.class.php';

htdocs/expensereport/export_csv.php

@@ -17,6 +17,7 @@
 
 /**
  *  \file       htdocs/expensereport/index.php
+ *  \ingroup    expensereport
  *  \brief      Page list of expenses
  */
 

htdocs/expensereport/index.php

@@ -21,6 +21,7 @@
 
 /**
  *  \file       htdocs/expensereport/index.php
+ *  \ingroup    expensereport
  *  \brief      Page list of expenses
  */
 

htdocs/expensereport/info.php

@@ -19,7 +19,7 @@
 
 /**
  * 	\file       htdocs/expensereport/info.php
- * 	\ingroup    trip
+ * 	\ingroup    expensereport
  * 	\brief      Page to show a trip information
  */
 

htdocs/expensereport/list.php

@@ -21,6 +21,7 @@
 
 /**
  *	    \file       htdocs/expensereport/index.php
+ *      \ingroup    expensereport
  *		\brief      list of expense reports
  */