Fix: doxygen

dev/translation/langAutoParser.class.php

@@ -147,12 +147,12 @@ class langAutoParser {
 	/**
 	 * Put in array translatedFiles[$file], line of a new tranlated pair
 	 *
-	 * @param unknown_type $content		Existing content of dest file
-	 * @param unknown_type $file		Target file name translated (xxxx.lang)
-	 * @param unknown_type $key			Key to translate
-	 * @param unknown_type $value		Existing value in source file
-	 * @param	string					Language code (ie: fr_FR)
-	 * @return	int						0=Nothing translated, 1=Record translated
+	 * @param 	$content		Existing content of dest file
+	 * @param 	$file			Target file name translated (xxxx.lang)
+	 * @param 	$key			Key to translate
+	 * @param 	$value			Existing value in source file
+	 * @param	string			Language code (ie: fr_FR)
+	 * @return	int				0=Nothing translated, 1=Record translated
 	 */
 	private function translateFileLine($content,$file,$key,$value,$mydestLang)
 	{
@@ -213,8 +213,8 @@ class langAutoParser {
 	 * Return translation of a value
 	 *
 	 * @param 	$src_texts		Array with one value
-	 * @param 	unknown_type $src_lang
-	 * @param 	unknown_type $dest_lang
+	 * @param 	$src_lang
+	 * @param 	$dest_lang
 	 * @return 	string			Value translated
 	 */
 	private function translateTexts($src_texts = array(), $src_lang, $dest_lang){

htdocs/bookmarks/bookmarks.lib.php

@@ -26,9 +26,9 @@
 /**
  * Add area with bookmarks in menu
  *
- * @param unknown_type $aDb
- * @param unknown_type $aLangs
- * @return unknown
+ * @param 	$aDb
+ * @param 	$aLangs
+ * @return	string
  */
 function printBookmarksList ($aDb, $aLangs)
 {

htdocs/comm/action/index.php

@@ -482,17 +482,17 @@ llxFooter('$Date$ - $Revision$');
 
 
 /**
- * \brief	Show event of a particular day
+ * Show event of a particular day
  *
- * @param unknown_type $db				Database handler
- * @param unknown_type $day				Day
- * @param unknown_type $month			Month
- * @param unknown_type $year			Year
- * @param unknown_type $monthshown      Month shown in calendar view
- * @param unknown_type $style			Style to use for this day
- * @param unknown_type $actionarray		Array of actions
- * @param unknown_type $maxPrint		Nb of actions to show each day on month view (0 means non limit)
- * @param unknown_type nbofchartoshow	Nb of characters to show for event line
+ * @param 	$db				Database handler
+ * @param 	$day			Day
+ * @param 	$month			Month
+ * @param 	$year			Year
+ * @param 	$monthshown     Month shown in calendar view
+ * @param 	$style			Style to use for this day
+ * @param 	$actionarray	Array of actions
+ * @param 	$maxPrint		Nb of actions to show each day on month view (0 means non limit)
+ * @param 	nbofchartoshow	Nb of characters to show for event line
  */
 function show_day_events($db, $day, $month, $year, $monthshown, $style, &$actionarray, $maxPrint=0, $nbofchartoshow=14)
 {

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

@@ -65,9 +65,8 @@ class Deplacement extends CommonObject
 	/**
 	 * Create object in database
 	 *
-	 * @param unknown_type $user	User that creat
-	 * @param unknown_type $type	Type of record: 0=trip, 1=credit note
-	 * @return unknown
+	 * @param 	$user	User that creat
+	 * @return 	int		<0 if KO, >0 if OK
 	 * @TODO Add ref number
 	 */
 	function create($user)

htdocs/compta/paiement/cheque/class/remisecheque.class.php

@@ -251,8 +251,8 @@ class RemiseCheque extends CommonObject
 	}
 
 	/**
-	 \brief  Supprime la remise en base
-	 \param  user utilisateur qui effectue l'operation
+	 *	Supprime la remise en base
+	 *	@param  user utilisateur qui effectue l'operation
 	 */
 	function delete($user='')
 	{
@@ -305,8 +305,8 @@ class RemiseCheque extends CommonObject
 	}
 
 	/**
-	 *  \brief  Validate receipt
-	 *  \param  user 	User
+	 *  Validate receipt
+	 *  @param  user 	User
 	 */
 	function validate($user)
 	{
@@ -446,7 +446,8 @@ class RemiseCheque extends CommonObject
 	/**
 	 *	\brief  	Build document
 	 *	\param 		model 			Model name
-	 *	\return  	int        		<0 if KO, >0 if OK
+	 *	\param 		outputlangs		Object langs
+	 * 	\return  	int        		<0 if KO, >0 if OK
 	 */
 	function generatePdf($model='blochet', $outputlangs)
 	{
@@ -527,8 +528,8 @@ class RemiseCheque extends CommonObject
 	}
 
 	/**
-	 *	\brief  Mets a jour le montant total
-	 *	\return int, 0 en cas de succes
+	 *	\brief  	Mets a jour le montant total
+	 *	\return 	int		0 en cas de succes
 	 */
 	function updateAmount()
 	{
@@ -586,9 +587,9 @@ class RemiseCheque extends CommonObject
 	}
 
 	/**
-	 \brief  Insere la remise en base
-	 \param  user utilisateur qui effectue l'operation
-	 \param  account_id Compte bancaire concerne
+	 *	\brief  	Insere la remise en base
+	 *	\param  	account_id 		Compte bancaire concerne
+	 * 	\return		int
 	 */
 	function removeCheck($account_id)
 	{
@@ -615,8 +616,8 @@ class RemiseCheque extends CommonObject
 		return 0;
 	}
 	/**
-	 \brief      Charge les proprietes ref_previous et ref_next
-	 \return     int   <0 si ko, 0 si ok
+	 *	\brief      Charge les proprietes ref_previous et ref_next
+	 *	\return     int   <0 si ko, 0 si ok
 	 */
 	function load_previous_next_id()
 	{

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

@@ -113,9 +113,9 @@ class FormMail
 	/**
 	 * Add a file into the list of attached files (stored in SECTION array)
 	 *
-	 * @param unknown_type $path
-	 * @param unknown_type $file
-	 * @param unknown_type $type
+	 * @param 	$path
+	 * @param 	$file
+	 * @param 	$type
 	 */
 	function add_attached_files($path,$file,$type)
 	{

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

@@ -461,10 +461,11 @@ class FormOther
 /**
  * Write all lines of a project (if parent = 0)
  *
- * @param unknown_type $inc
- * @param unknown_type $parent
- * @param unknown_type $lines
- * @param unknown_type $level
+ * @param 	$inc
+ * @param 	$parent
+ * @param 	$lines
+ * @param 	$level
+ * @param 	$selected
  */
 function PLineSelect(&$inc, $parent, $lines, $level=0, $selected=0)
 {

htdocs/core/searchpostalcode.php

@@ -188,10 +188,10 @@ llxFooter('$Date$ - $Revision$',0);
 
 
 /**
- * Enter description here...
+ * Return cursor on request to find zip/town
  *
- * @param unknown_type $table
- * @return unknown
+ * @param 	$table
+ * @return 	cursor
  */
 function run_request($table)
 {

htdocs/fourn/class/fournisseur.commande.class.php

@@ -925,12 +925,12 @@ class CommandeFournisseur extends Commande
 	/**
 	 * Add a product into a stock warehouse.
 	 *
-	 * @param unknown_type $user
-	 * @param unknown_type $product
-	 * @param unknown_type $qty
-	 * @param unknown_type $entrepot	Id of warehouse to add product
-	 * @param unknown_type $price
-	 * @return unknown
+	 * @param 	$user
+	 * @param 	$product
+	 * @param 	$qty
+	 * @param 	$entrepot	Id of warehouse to add product
+	 * @param 	$price
+	 * @return 	int			<0 if KO, =0 if OK
 	 */
 	function DispatchProduct($user, $product, $qty, $entrepot, $price=0)
 	{
@@ -988,8 +988,8 @@ class CommandeFournisseur extends Commande
 	}
 
 	/**
-	 * Supprime une ligne de la commande
-	 *
+	 * 	Delete line
+	 *	@param		idligne
 	 */
 	function delete_line($idligne)
 	{

htdocs/ftp/index.php

@@ -624,14 +624,14 @@ llxFooter('$Date$ - $Revision$');
 
 
 /**
- * Enter description here...
+ * Connect to FTP server
  *
- * @param unknown_type $ftp_server
- * @param unknown_type $ftp_port
- * @param unknown_type $ftp_user
- * @param unknown_type $ftp_password
- * @param unknown_type $section
- * @return unknown
+ * @param 	$ftp_server
+ * @param 	$ftp_port
+ * @param 	$ftp_user
+ * @param 	$ftp_password
+ * @param 	$section
+ * @return	int 	<0 if OK, >0 if KO
  */
 function dol_ftp_connect($ftp_server, $ftp_port, $ftp_user, $ftp_password, $section)
 {
@@ -683,9 +683,9 @@ function dol_ftp_connect($ftp_server, $ftp_port, $ftp_user, $ftp_password, $sect
 /**
  * Tell if an entry is a FTP directory
  *
- * @param unknown_type $connect_id
- * @param unknown_type $dir
- * @return unknown
+ * @param 		$connect_id
+ * @param 		$dir
+ * @return
  */
 function ftp_isdir($connect_id,$dir)
 {

htdocs/imports/import.php

@@ -1936,8 +1936,8 @@ function show_elem($fieldssource,$i,$pos,$key,$var,$nostyle='')
 /**
  * Return not used field number
  *
- * @param unknown_type $listofkey
- * @return unknown
+ * @param 	$listofkey
+ * @return
  */
 function getnewkey(&$fieldssource,&$listofkey)
 {

htdocs/install/inc.php

@@ -255,10 +255,10 @@ function conf($dolibarr_main_document_root)
 /**
  * Show header of install pages
  *
- * @param unknown_type $soutitre
- * @param unknown_type $next
- * @param unknown_type $action
- * @param unknown_type $param
+ * @param 	$soutitre
+ * @param 	$next
+ * @param 	$action
+ * @param 	$param
  */
 function pHeader($soutitre,$next,$action='set',$param='')
 {
@@ -346,8 +346,8 @@ function pFooter($nonext=0,$setuplang='',$jscheckfunction='')
 /**
  * Log function for install pages
  *
- * @param unknown_type $message
- * @param unknown_type $level
+ * @param 	$message
+ * @param 	$level
  */
 function dolibarr_install_syslog($message, $level=LOG_DEBUG)
 {

htdocs/lib/CMailFile.class.php

@@ -611,8 +611,8 @@ class CMailFile
 	/**
 	 * Correct an uncomplete html string
 	 *
-	 * @param unknown_type $msg
-	 * @return unknown
+	 * @param 		$msg
+	 * @return
 	 */
 	function checkIfHTML($msg)
 	{

htdocs/lib/agenda.lib.php

@@ -28,18 +28,18 @@
 /**
  * Show filter form in agenda view
  *
- * @param unknown_type $canedit
- * @param unknown_type $status
- * @param unknown_type $year
- * @param unknown_type $month
- * @param unknown_type $day
- * @param unknown_type $showborthday
- * @param unknown_type $action
- * @param unknown_type $filtera
- * @param unknown_type $filtert
- * @param unknown_type $filterd
- * @param unknown_type $pid
- * @param unknown_type $socid
+ * @param 		$canedit
+ * @param 		$status
+ * @param 		$year
+ * @param 		$month
+ * @param 		$day
+ * @param 		$showborthday
+ * @param 		$action
+ * @param 		$filtera
+ * @param 		$filtert
+ * @param 		$filterd
+ * @param 		$pid
+ * @param 		$socid
  */
 function print_actions_filter($form,$canedit,$status,$year,$month,$day,$showborthday,$action,$filtera,$filtert,$filterd,$pid,$socid)
 {

htdocs/lib/company.lib.php

@@ -146,8 +146,8 @@ function societe_prepare_head($objsoc)
 /**
  * Return array of tabs to used on page
  *
- * @param unknown_type $objsoc
- * @return unknown
+ * @param 	$objsoc
+ * @return
  */
 function societe_prepare_head2($objsoc)
 {

htdocs/societe/class/societe.class.php

@@ -1214,10 +1214,10 @@ class Societe extends CommonObject
 
 
 	/**
-	 * Enter description here...
+	 * Set the price level
 	 *
-	 * @param unknown_type $price_level
-	 * @param unknown_type $user
+	 * @param $price_level
+	 * @param $user
 	 */
 	function set_price_level($price_level, $user)
 	{
@@ -1994,7 +1994,7 @@ class Societe extends CommonObject
 	/**
 	 * Add a line in log table to save status change.
 	 *
-	 * @param unknown_type $id_status
+	 * @param $id_status
 	 */
 	function set_status($id_status)
 	{