Fix: Doxygen

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

@@ -139,7 +139,7 @@ class FormMail
 	/**
 	 * Remove a file from the list of attached files (stored in SECTION array)
 	 *
-	 * @param unknown_type $file
+	 * @param  $keytodelete     Key in file array
 	 */
 	function remove_attached_files($keytodelete)
 	{
@@ -164,7 +164,7 @@ class FormMail
 	/**
 	 * Return list of attached files (stored in SECTION array)
 	 *
-	 * @return	unknown_type $type
+	 * @return	array       array('paths'=> ,'names'=>, 'mimes'=> )
 	 */
 	function get_attached_files()
 	{

htdocs/core/class/menubase.class.php

@@ -345,12 +345,12 @@ class Menubase
 	/**
 	 *	Load entries found in database in a menu array
 	 *
-	 * @param unknown_type $newmenu		Menu array to complete
-	 * @param unknown_type $mainmenu	Value for mainmenu that defined top menu
-	 * @param unknown_type $leftmenu	Value for left that defined leftmenu
-	 * @param unknown_type $type_user 	0=Internal,1=External,2=All
-	 * @param menu_handler				Name of menu_handler used (auguria, eldy...)
-	 * @return 	array					Menu array completed
+	 * @param  $newmenu        Menu array to complete
+	 * @param  $mainmenu       Value for mainmenu that defined top menu
+	 * @param  $leftmenu       Value for left that defined leftmenu
+	 * @param  $type_user      0=Internal,1=External,2=All
+	 * @param  $menu_handler   Name of menu_handler used (auguria, eldy...)
+	 * @return array           Menu array completed
 	 */
 	function menuLeftCharger($newmenu, $mainmenu, $myleftmenu, $type_user, $menu_handler)
 	{

htdocs/includes/menus/barre_left/auguria.lib.php

@@ -28,7 +28,9 @@
 /**
  * Core function to output left menu auguria
  *
- * @param unknown_type $db
+ * @param      db                  Database handler
+ * @param      menu_array_before   Table of menu entries to show before entries of menu handler
+ * @param      menu_array_after    Table of menu entries to show after entries of menu handler
  */
 function print_left_auguria_menu($db,$menu_array_before,$menu_array_after)
 {

htdocs/includes/menus/barre_left/eldy.lib.php

@@ -28,7 +28,9 @@
 /**
  * Core function to output left menu eldy
  *
- * @param unknown_type $db
+ * @param      db                  Database handler
+ * @param      menu_array_before   Table of menu entries to show before entries of menu handler
+ * @param      menu_array_after    Table of menu entries to show after entries of menu handler
  */
 function print_left_eldy_menu($db,$menu_array_before,$menu_array_after)
 {

htdocs/includes/menus/barre_top/auguria.lib.php

@@ -28,9 +28,9 @@
 /**
  * Core function to output top menu auguria
  *
- * @param unknown_type $db
- * @param unknown_type $atarget
- * @param unknown_type $hideifnotallowed
+ * @param $db
+ * @param $atarget
+ * @param $hideifnotallowed
  */
 function print_auguria_menu($db,$atarget,$hideifnotallowed)
 {

htdocs/includes/menus/barre_top/eldy.lib.php

@@ -27,9 +27,9 @@
 /**
  * Core function to output top menu eldy
  *
- * @param unknown_type $db
- * @param unknown_type $atarget
- * @param unknown_type $hideifnotallowed
+ * @param $db
+ * @param $atarget
+ * @param $hideifnotallowed
  */
 function print_eldy_menu($db,$atarget,$hideifnotallowed)
 {

htdocs/includes/modules/action/rapport.pdf.php

@@ -142,8 +142,9 @@ class CommActionRapport
 	/**
 	 * Write content of pages
 	 *
-	 * @param unknown_type 		$pdf
-	 * @return 	int				1
+	 * @param      $pdf
+     * @param      $outputlangs
+	 * @return     int				1
 	 */
 	function _pages(&$pdf, $outputlangs)
 	{

htdocs/includes/modules/commande/pdf_edison.modules.php

@@ -446,11 +446,11 @@ class pdf_edison extends ModelePDFCommandes
 	/**
 	 * Enter description here...
 	 *
-	 * @param unknown_type $pdf
-	 * @param unknown_type $tab_top
-	 * @param unknown_type $tab_height
-	 * @param unknown_type $nexY
-	 * @param unknown_type $outputlangs
+	 * @param $pdf
+	 * @param $tab_top
+	 * @param $tab_height
+	 * @param $nexY
+	 * @param $outputlangs
 	 */
 	function _tableau(&$pdf, $tab_top, $tab_height, $nexY, $outputlangs)
 	{

htdocs/includes/modules/mailings/dolibarr_services_expired.modules.php

@@ -37,7 +37,7 @@ class mailing_dolibarr_services_expired extends MailingTargets
 	/**
 	 * Constructor
 	 *
-	 * @param unknown_type $DB
+	 * @param  $DB
 	 * @return mailing_dolibarr_services_expired
 	 */
 	function mailing_dolibarr_services_expired($DB)

htdocs/includes/modules/member/PDF_card.class.php

@@ -102,10 +102,10 @@ class PDF_card extends FPDF {
 	/**
 	 * Constructor
 	 *
-	 * @param unknown_type $format		Avery format of label paper. For example 5160, 5161, 5162, 5163, 5164, 8600, L7163
-	 * @param unknown_type $posX
-	 * @param unknown_type $posY
-	 * @param unknown_type $unit
+	 * @param  $format		Avery format of label paper. For example 5160, 5161, 5162, 5163, 5164, 8600, L7163
+	 * @param  $posX
+	 * @param  $posY
+	 * @param  $unit
 	 * @return PDF_card
 	 */
 	function PDF_card ($format, $posX=1, $posY=1, $unit='mm')

htdocs/includes/modules/project/modules_project.php

@@ -201,9 +201,9 @@ function project_pdf_create($db, $comid, $modele,$outputlangs)
 /**
  * Enter description here...
  *
- * @param unknown_type $db
- * @param unknown_type $projectid
- * @return unknown
+ * @param   $db
+ * @param   $projectid
+ * @return  int
  */
 function project_delete_preview($db, $projectid)
 {

htdocs/includes/modules/propale/pdf_propale_jaune.modules.php

@@ -436,11 +436,11 @@ class pdf_propale_jaune extends ModelePDFPropales
 	/**
 	 * Enter description here...
 	 *
-	 * @param unknown_type $pdf
-	 * @param unknown_type $tab_top
-	 * @param unknown_type $tab_height
-	 * @param unknown_type $nexY
-	 * @param unknown_type $outputlangs
+	 * @param $pdf
+	 * @param $tab_top
+	 * @param $tab_height
+	 * @param $nexY
+	 * @param $outputlangs
 	 */
 	function _tableau(&$pdf, $tab_top, $tab_height, $nexY, $outputlangs)
 	{

htdocs/includes/modules/supplier_order/modules_commandefournisseur.php

@@ -198,9 +198,9 @@ function supplier_order_pdf_create($db, $comid, $modele,$outputlangs)
 /**
  * Enter description here...
  *
- * @param unknown_type $db
- * @param unknown_type $propalid
- * @return unknown
+ * @param   $db
+ * @param   $propalid
+ * @return  int
  */
 function supplier_order_delete_preview($db, $propalid)
 {

htdocs/install/inc.php

@@ -296,9 +296,9 @@ function pHeader($soutitre,$next,$action='set',$param='')
 /**
  * Output footer of install pages
  *
- * @param unknown_type $nonext
- * @param unknown_type $setuplang
- * @param unknown_type $jscheckfunction
+ * @param $nonext
+ * @param $setuplang
+ * @param $jscheckfunction
  */
 function pFooter($nonext=0,$setuplang='',$jscheckfunction='')
 {

htdocs/lib/CMailFile.class.php

@@ -740,8 +740,8 @@ class CMailFile
 	/**
 	 * Try to create a socket connection
 	 *
-	 * @param 		unknown_type $host. Add ssl:// for SSL/TLS.
-	 * @param 		unknown_type $port. Example: 25, 465
+	 * @param 		$host. Add ssl:// for SSL/TLS.
+	 * @param 		$port. Example: 25, 465
 	 * @return 		Socket id if ok, 0 if KO
 	 */
 	function check_server_port($host,$port)

htdocs/lib/antivir.class.php

@@ -41,7 +41,7 @@ class AntiVir
 	/**
 	 * Constructor
 	 *
-	 * @param unknown_type $db
+	 * @param  $db
 	 * @return AntiVir
 	 */
 	function AntiVir($db)

htdocs/lib/contact.lib.php

@@ -20,7 +20,7 @@
 /**
  *	    \file       htdocs/lib/contact.lib.php
  *		\brief      Ensemble de fonctions de base pour les contacts
- *		\version    $Id$ 
+ *		\version    $Id$
  *
  *		Ensemble de fonctions de base de dolibarr sous forme d'include
  */
@@ -28,41 +28,41 @@
 /**
  * Enter description here...
  *
- * @param unknown_type $contrat
- * @return unknown
+ * @param   $contrat
+ * @return  array
  */
 function contact_prepare_head($contrat)
 {
 	global $langs, $conf;
-	
+
 	$h = 0;
 	$head = array();
-	
+
 	$head[$h][0] = DOL_URL_ROOT.'/contact/fiche.php?id='.$_GET["id"];
 	$head[$h][1] = $langs->trans("Card");
 	$head[$h][2] = 'general';
 	$h++;
-	
+
 	if ($conf->ldap->enabled && $conf->global->LDAP_CONTACT_ACTIVE)
 	{
 		$langs->load("ldap");
-		
+
 		$head[$h][0] = DOL_URL_ROOT.'/contact/ldap.php?id='.$_GET["id"];
 		$head[$h][1] = $langs->trans("LDAPCard");
 		$head[$h][2] = 'ldap';
 		$h++;
 	}
-	
+
 	$head[$h][0] = DOL_URL_ROOT.'/contact/perso.php?id='.$_GET["id"];
 	$head[$h][1] = $langs->trans("PersonalInformations");
 	$head[$h][2] = 'perso';
 	$h++;
-	
+
 	$head[$h][0] = DOL_URL_ROOT.'/contact/exportimport.php?id='.$_GET["id"];
 	$head[$h][1] = $langs->trans("ExportImport");
 	$head[$h][2] = 'exportimport';
 	$h++;
-	
+
 	$head[$h][0] = DOL_URL_ROOT.'/contact/info.php?id='.$_GET["id"];
 	$head[$h][1] = $langs->trans("Info");
 	$head[$h][2] = 'info';

htdocs/lib/emailing.lib.php

@@ -26,8 +26,8 @@
 /**
  * Enter description here...
  *
- * @param unknown_type $contrat
- * @return unknown
+ * @param   $mil
+ * @return  array
  */
 function emailing_prepare_head($mil)
 {

htdocs/lib/files.lib.php

@@ -125,11 +125,11 @@ function dol_dir_list($path, $types="all", $recursive=0, $filter="", $excludefil
 }
 
 /**
- * \brief	Fast compare of 2 files identified by their properties ->name, ->date and ->size
+ * Fast compare of 2 files identified by their properties ->name, ->date and ->size
  *
- * @param 	unknown_type $a		File 1
- * @param 	unknown_type $b		File 2
- * @return 	int					1, 0, 1
+ * @param 	$a		File 1
+ * @param 	$b		File 2
+ * @return 	int		1, 0, 1
  */
 function dol_compare_file($a, $b)
 {

htdocs/lib/functions.lib.php

@@ -953,9 +953,9 @@ function isValidEmail($address)
 /**
  * Make a strlen call. Works even if mbstring module not enabled.
  *
- * @param unknown_type $string
- * @param unknown_type $stringencoding
- * @return unknown
+ * @param   $string
+ * @param   $stringencoding
+ * @return  int
  */
 function dol_strlen($string,$stringencoding='')
 {
@@ -978,11 +978,11 @@ function dol_strlen($string,$stringencoding='')
 /**
  * Make a substring. Works even in mbstring module not enabled
  *
- * @param unknown_type $string
- * @param unknown_type $start
- * @param unknown_type $length
- * @param unknown_type $stringencoding
- * @return unknown
+ * @param   $string
+ * @param   $start
+ * @param   $length
+ * @param   $stringencoding
+ * @return  string
  */
 function dol_substr($string,$start,$length,$stringencoding='')
 {

htdocs/lib/functions2.lib.php

@@ -342,14 +342,14 @@ function array2table($data,$tableMarkup=1,$tableoptions='',$troptions='',$tdopti
 /**
  * Return next value for a mask
  *
- * @param unknown_type 	$db				Database handler
- * @param 				$mask			Mask to use
- * @param unknown_type 	$table			Table containing field with counter
- * @param unknown_type 	$field			Field containing already used values of counter
- * @param unknown_type 	$where			To add a filter on selection (for exemple to filter on invoice types)
- * @param unknown_type 	$objsoc			The company that own the object we need a counter for
- * @param unknown_type 	$date			Date to use for the {y},{m},{d} tags.
- * @return 	string		New value
+ * @param   $db				Database handler
+ * @param   $mask			Mask to use
+ * @param   $table			Table containing field with counter
+ * @param   $field			Field containing already used values of counter
+ * @param   $where			To add a filter on selection (for exemple to filter on invoice types)
+ * @param   $objsoc			The company that own the object we need a counter for
+ * @param   $date			Date to use for the {y},{m},{d} tags.
+ * @return 	string		    New value
  */
 function get_next_value($db,$mask,$table,$field,$where='',$objsoc='',$date='')
 {
@@ -577,14 +577,10 @@ function get_next_value($db,$mask,$table,$field,$where='',$objsoc='',$date='')
 /**
  * Check value
  *
- * @param unknown_type 	$db				Database handler
- * @param 				$mask			Mask to use
- * @param unknown_type 	$table			Table containing field with counter
- * @param unknown_type 	$field			Field containing already used values of counter
- * @param unknown_type 	$where			To add a filter on selection (for exemple to filter on invoice types)
- * @param unknown_type 	$valueforccc
- * @param unknown_type 	$date
- * @return		int			<0 if KO, 0 if OK
+ * @param 	$db			Database handler
+ * @param 	$mask		Mask to use
+ * @param 	$value
+ * @return	int         <0 if KO, 0 if OK
  */
 function check_value($mask,$value)
 {

htdocs/lib/ldap.lib.php

@@ -109,12 +109,13 @@ function show_ldap_test_button($butlabel,$testlabel,$key,$dn,$objectclass)
 /**
  * Show an LDAP array in an HTML to records.
  *
- * @param unknown_type $result	Array to show. This array is already encoded into charset_output
- * @param unknown_type $level
- * @param unknown_type $count
- * @param unknown_type $var
- * @param unknown_type $hide
- * @return unknown
+ * @param   $result	    Array to show. This array is already encoded into charset_output
+ * @param   $level
+ * @param   $count
+ * @param   $var
+ * @param   $hide
+ * @param   $subcount
+ * @return  intr
  */
 function show_ldap_content($result,$level,$count,$var,$hide=0,$subcount=0)
 {

htdocs/lib/project.lib.php

@@ -261,12 +261,12 @@ function select_projects($socid=-1, $selected='', $htmlname='projectid')
 /**
  * Enter description here...
  *
- * @param unknown_type $inc
- * @param unknown_type $parent
- * @param unknown_type $lines
- * @param unknown_type $level
- * @param unknown_type $tasksrole
- * @return unknown
+ * @param   $inc
+ * @param   $parent
+ * @param   $lines
+ * @param   $level
+ * @param   $projectsrole
+ * @return  $inc
  */
 function PLinesb(&$inc, $parent, $lines, &$level, &$projectsrole)
 {
@@ -541,8 +541,8 @@ function SearchTaskInChild(&$inc, $parent, &$lines, &$taskrole)
 
 /**
  * Clean task not linked to a parent
- * @param unknown_type $db
- * @return		int		Nb of records deleted
+ * @param   $db     Database handler
+ * @return	int		Nb of records deleted
  */
 function clean_orphelins($db)
 {
@@ -598,10 +598,10 @@ function clean_orphelins($db)
 /**
  * Return HTML table with list of projects and number of opened tasks
  *
- * @param unknown_type $db
- * @param unknown_type $mine
- * @param unknown_type $socid
- * @param unknown_type $projectsListId
+ * @param   $db
+ * @param   $mine
+ * @param   $socid
+ * @param   $projectsListId
  */
 function print_projecttasks_array($db,$mine,$socid,$projectsListId)
 {

htdocs/lib/sendings.lib.php

@@ -115,8 +115,8 @@ function delivery_prepare_head($object)
 /**
  * List sendings and receive receipts
  *
- * @param unknown_type $option
- * @return unknown
+ * @param   $option
+ * @return
  */
 function show_list_sending_receive($origin='commande',$origin_id,$filter='')
 {

htdocs/lib/stock.lib.php

@@ -26,8 +26,8 @@
 /**
  * Enter description here...
  *
- * @param unknown_type $contrat
- * @return unknown
+ * @param   $entrepot
+ * @return  array
  */
 function stock_prepare_head($entrepot)
 {

htdocs/paybox/paybox.lib.php

@@ -228,8 +228,8 @@ function print_paybox_redirect($PRICE,$CURRENCY,$EMAIL,$urlok,$urlko,$TAG)
 /**
  * Show footer of company in HTML pages
  *
- * @param unknown_type $fromcompany
- * @param unknown_type $langs
+ * @param   $fromcompany
+ * @param   $langs
  */
 function html_print_footer($fromcompany,$langs)
 {

htdocs/product/stock/class/mouvementstock.class.php

@@ -323,8 +323,8 @@ class MouvementStock
 	/**
 	 * Return nb of subproducts lines for a product
 	 *
-	 * @param unknown_type $id
-	 * @return unknown
+	 * @param      $id
+	 * @return     int
 	 */
 	function nbOfSubProdcuts($id)
 	{

htdocs/projet/class/project.class.php

@@ -139,8 +139,9 @@ class Project extends CommonObject
 	/**
 	 * Update a project
 	 *
-	 * @param unknown_type $user
-	 * @return unknown
+	 * @param  $user       User object of making update
+	 * @param  $notrigger  1=Disable all triggers
+	 * @return int
 	 */
 	function update($user, $notrigger=0)
 	{

htdocs/support/inc.php

@@ -225,8 +225,8 @@ function pHeader($soutitre,$next,$action='none')
 /**
  * Enter description here...
  *
- * @param unknown_type $nonext
- * @param unknown_type $setuplang
+ * @param   $nonext
+ * @param   $setuplang
  */
 function pFooter($nonext=0,$setuplang='')
 {
@@ -239,10 +239,10 @@ function pFooter($nonext=0,$setuplang='')
 }
 
 /**
- * Enter description here...
+ * Output a text into a log file
  *
- * @param unknown_type $message
- * @param unknown_type $level
+ * @param   $message
+ * @param   $level
  */
 function dolibarr_support_syslog($message, $level=LOG_DEBUG)
 {