Doxygen

htdocs/core/modules/contract/modules_contract.php

@@ -27,6 +27,9 @@
  *  \brief      File of class to manage contract numbering
  */
 
+/**
+ * Parent class for all contract numbering modules
+ */
 class ModelNumRefContracts
 {
 	var $error='';

htdocs/core/modules/dons/modules_don.php

@@ -156,7 +156,7 @@ function don_create($db, $id, $message, $modele, $outputlangs)
 
     $dir = DOL_DOCUMENT_ROOT . "/core/modules/dons/";
 
-    // Positionne modele sur le nom du modele <20> utiliser
+    // Set template to use
     if (! dol_strlen($modele))
     {
         if ($conf->global->DON_ADDON_MODEL)

htdocs/core/modules/export/export_csv.modules.php

@@ -72,36 +72,71 @@ class ExportCsv extends ModeleExports
 
 	}
 
+	/**
+	 * getDriverId
+	 *
+	 * @return int
+	 */
 	function getDriverId()
 	{
 		return $this->id;
 	}
 
+	/**
+	 * getDriverLabel
+	 *
+	 * @return string
+	 */
 	function getDriverLabel()
 	{
 		return $this->label;
 	}
 
+	/**
+	 * getDriverDesc
+	 *
+	 * @return string
+	 */
 	function getDriverDesc()
 	{
 		return $this->desc;
 	}
 
+	/**
+	 * getDriverExtension
+	 *
+	 * @return string
+	 */
 	function getDriverExtension()
 	{
 		return $this->extension;
 	}
 
+	/**
+	 * getDriverVersion
+	 *
+	 * @return string
+	 */
 	function getDriverVersion()
 	{
 		return $this->version;
 	}
 
+	/**
+	 * getLabelLabel
+	 *
+	 * @return string
+	 */
 	function getLibLabel()
 	{
 		return $this->label_lib;
 	}
 
+	/**
+	 * getLibVersion
+	 *
+	 * @return string
+	 */
 	function getLibVersion()
 	{
 		return $this->version_lib;

htdocs/core/modules/export/export_excel.modules.php

@@ -71,36 +71,71 @@ class ExportExcel extends ModeleExports
 		$this->row=0;
 	}
 
+	/**
+	 * getDriverId
+	 *
+	 * @return int
+	 */
 	function getDriverId()
 	{
 		return $this->id;
 	}
 
+	/**
+	 * getDriverLabel
+	 *
+	 * @return string
+	 */
 	function getDriverLabel()
 	{
 		return $this->label;
 	}
 
-    function getDriverDesc()
+	/**
+	 * getDriverDesc
+	 *
+	 * @return string
+	 */
+	function getDriverDesc()
     {
         return $this->desc;
     }
 
-	function getDriverExtension()
+	/**
+	 * getDriverExtension
+	 *
+	 * @return string
+	 */
+    function getDriverExtension()
 	{
 		return $this->extension;
 	}
 
+	/**
+	 * getDriverVersion
+	 *
+	 * @return string
+	 */
 	function getDriverVersion()
 	{
 		return $this->version;
 	}
 
+	/**
+	 * getLibLabel
+	 *
+	 * @return string
+	 */
 	function getLibLabel()
 	{
 		return $this->label_lib;
 	}
 
+	/**
+	 * getLibVersion
+	 *
+	 * @return string
+	 */
 	function getLibVersion()
 	{
 		return $this->version_lib;

htdocs/core/modules/export/export_excel2007.modules.php

@@ -72,36 +72,71 @@ class ExportExcel2007 extends ExportExcel
 		$this->row=0;
 	}
 
+	/**
+	 * getDriverLabel
+	 *
+	 * @return int
+	 */
 	function getDriverId()
 	{
 		return $this->id;
 	}
 
+	/**
+	 * getDriverLabel
+	 *
+	 * @return string
+	 */
 	function getDriverLabel()
 	{
 		return $this->label;
 	}
 
-    function getDriverDesc()
+	/**
+	 * getDriverDesc
+	 *
+	 * @return string
+	 */
+	function getDriverDesc()
     {
         return $this->desc;
     }
 
-	function getDriverExtension()
+	/**
+	 * getDriverExtension
+	 *
+	 * @return string
+	 */
+    function getDriverExtension()
 	{
 		return $this->extension;
 	}
 
+	/**
+	 * getDriverVersion
+	 *
+	 * @return string
+	 */
 	function getDriverVersion()
 	{
 		return $this->version;
 	}
 
+	/**
+	 * getLibLabel
+	 *
+	 * @return string
+	 */
 	function getLibLabel()
 	{
 		return $this->label_lib;
 	}
 
+	/**
+	 * getLibVersion
+	 *
+	 * @return string
+	 */
 	function getLibVersion()
 	{
 		return $this->version_lib;

htdocs/core/modules/export/export_tsv.modules.php

@@ -66,36 +66,71 @@ class ExportTsv extends ModeleExports
         $this->version_lib=DOL_VERSION;
     }
 
+	/**
+	 * getDriverId
+	 *
+	 * @return int
+	 */
     function getDriverId()
     {
         return $this->id;
     }
 
+	/**
+	 * getDriverLabel
+	 *
+	 * @return string
+	 */
     function getDriverLabel()
     {
         return $this->label;
     }
 
+	/**
+	 * getDriverDesc
+	 *
+	 * @return string
+	 */
     function getDriverDesc()
     {
         return $this->desc;
     }
 
+	/**
+	 * getDriverExtension
+	 *
+	 * @return string
+	 */
     function getDriverExtension()
     {
         return $this->extension;
     }
 
+	/**
+	 * getDriverVersion
+	 *
+	 * @return string
+	 */
     function getDriverVersion()
     {
         return $this->version;
     }
 
+	/**
+	 * getLibLabel
+	 *
+	 * @return string
+	 */
     function getLibLabel()
     {
         return $this->label_lib;
     }
 
+	/**
+	 * getLibVersion
+	 *
+	 * @return string
+	 */
     function getLibVersion()
     {
         return $this->version_lib;

htdocs/core/modules/export/modules_export.php

@@ -92,7 +92,10 @@ class ModeleExports extends CommonDocGenerator    // This class can't be abstrac
 
 
 	/**
-	 *      \brief      Return picto of export driver
+	 *  Return picto of export driver
+	 *
+	 *  @param	string	$key	Key of driver
+	 *  @return	string			Picto string
 	 */
 	function getPicto($key)
 	{
@@ -100,7 +103,10 @@ class ModeleExports extends CommonDocGenerator    // This class can't be abstrac
 	}
 
 	/**
-	 *      \brief      Renvoi libelle d'un driver export
+	 *  Renvoi libelle d'un driver export
+	 *
+	 *  @param	string	$key	Key of driver
+	 *  @return	string			Label
 	 */
 	function getDriverLabel($key)
 	{
@@ -108,7 +114,10 @@ class ModeleExports extends CommonDocGenerator    // This class can't be abstrac
 	}
 
 	/**
-	 *      \brief      Renvoi le descriptif d'un driver export
+	 *  Renvoi le descriptif d'un driver export
+	 *
+	 *  @param	string	$key	Key of driver
+	 *  @return	string			Description
 	 */
 	function getDriverDesc($key)
 	{
@@ -116,7 +125,10 @@ class ModeleExports extends CommonDocGenerator    // This class can't be abstrac
 	}
 
 	/**
-	 *      \brief      Renvoi version d'un driver export
+	 *  Renvoi version d'un driver export
+	 *
+	 *  @param	string	$key	Key of driver
+	 *  @return	string			Driver version
 	 */
 	function getDriverVersion($key)
 	{
@@ -124,7 +136,10 @@ class ModeleExports extends CommonDocGenerator    // This class can't be abstrac
 	}
 
 	/**
-	 *      \brief      Renvoi libelle de librairie externe du driver
+	 *  Renvoi libelle de librairie externe du driver
+	 *
+	 *  @param	string	$key	Key of driver
+	 *  @return	string			Label of library
 	 */
 	function getLibLabel($key)
 	{
@@ -132,7 +147,10 @@ class ModeleExports extends CommonDocGenerator    // This class can't be abstrac
 	}
 
 	/**
-	 *      \brief      Renvoi version de librairie externe du driver
+	 *  Renvoi version de librairie externe du driver
+	 *
+	 *  @param	string	$key	Key of driver
+	 *  @return	string			Version of library
 	 */
 	function getLibVersion($key)
 	{