Doxygen

htdocs/admin/external_rss.php

@@ -205,7 +205,7 @@ print '</tr>';
 print '<tr class="impair">';
 print '<td width="100">'.$langs->trans("Title").'</td>';
 print '<td><input type="text" name="external_rss_title_'.($lastexternalrss+1).'" value="'.@constant("EXTERNAL_RSS_TITLE_" . ($lastexternalrss+1)).'" size="64"></td>';
-print '<td>April,<br>LinuxFR,<br>Lolix</td>';
+print '<td>An interesting RSS feed</td>';
 print '</tr>';
 
 print '<tr class="pair">';

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

@@ -206,8 +206,8 @@ class Propal extends CommonObject
     /**
      *	Adding line of fixed discount in the proposal in DB
      *
-     *	@param     int		@idremise			Id of fixed discount
+     *	@param     int		$idremise			Id of fixed discount
-     *  @return    int          				>0 si ok, <0 si ko
+     *  @return    int          				>0 if OK, <0 if KO
      */
     function insert_discount($idremise)
     {
@@ -828,6 +828,7 @@ class Propal extends CommonObject
 
     /**
      *	Insert into DB a proposal object completely defined by its data members (ex, results from copy).
+     *
      *	@param 		User	$user	User that create
      *	@return    	int				Id of the new object if ok, <0 if ko
      *	@see       	create

htdocs/core/boxes/box_external_rss.php

@@ -48,6 +48,7 @@ class box_external_rss extends ModeleBoxes
      *  Constructor
      *
      * 	@param	DoliDB	$db			Database handler
+     *  @param	string	$param		More parameters
      */
     function box_external_rss($db,$param)
     {

htdocs/core/boxes/box_prospect.php

@@ -39,21 +39,22 @@ class box_prospect extends ModeleBoxes
 	var $depends = array("societe");
 
 	var $db;
-	var $param;
 
 	var $info_box_head = array();
 	var $info_box_contents = array();
 
+
 	/**
      *  Constructor
+     *
+     *  @param	DoliDB	$db		Database handler
 	 */
-	function box_prospect($DB,$param)
+	function box_prospect($db)
 	{
 		global $langs;
 		$langs->load("boxes");
 
-		$this->db=$DB;
+		$this->db=$db;
-		$this->param=$param;
 
 		$this->boxlabel=$langs->transnoentitiesnoconv("BoxLastProspects");
 	}

htdocs/core/class/canvas.class.php

@@ -46,7 +46,7 @@ class Canvas
    /**
 	*   Constructor
 	*
-	*   @param     DoliDB	$DB          	Database handler
+	*   @param     DoliDB	$db          	Database handler
 	*   @param     string   $actiontype		Action type ('create', 'view', 'edit', 'list')
 	*/
 	function __construct($db, $actiontype='view')

htdocs/core/class/commondocgenerator.class.php

@@ -38,8 +38,9 @@ abstract class CommonDocGenerator
     /**
      * Define array with couple subtitution key => subtitution value
      *
-     * @param   $user               User
+     * @param   User		$user           User
-     * @param   $outputlangs        Language object for output
+     * @param   Translate	$outputlangs    Language object for output
+     * @return	array						Array of substitution key->code
      */
     function get_substitutionarray_user($user,$outputlangs)
     {
@@ -61,8 +62,9 @@ abstract class CommonDocGenerator
     /**
      * Define array with couple subtitution key => subtitution value
      *
-     * @param   $mysoc
+     * @param   Societe		$mysoc			Object thirdparty
-     * @param   $outputlangs        Language object for output
+     * @param   Translate	$outputlangs    Language object for output
+     * @return	array						Array of substitution key->code
      */
     function get_substitutionarray_mysoc($mysoc,$outputlangs)
     {
@@ -103,8 +105,9 @@ abstract class CommonDocGenerator
     /**
      * Define array with couple subtitution key => subtitution value
      *
-     * @param   $object
+     * @param	Object		$object			Object
-     * @param   $outputlangs        Language object for output
+     * @param   Translate	$outputlangs    Language object for output
+     * @return	array						Array of substitution key->code
      */
     function get_substitutionarray_thirdparty($object,$outputlangs)
     {

htdocs/core/class/commonobject.class.php

@@ -2433,8 +2433,8 @@ abstract class CommonObject
      *
      *  @param	string		$action				GET/POST action
      * 	@param	array	    $line		       	Selected object line to output
-     *  @param  string	    $var               	Is it a an odd line
+     *  @param  string	    $var               	Is it a an odd line (true)
-     *  @param  int		    $num               	Number of line
+     *  @param  int		    $num               	Number of line (0)
      *  @param  int		    $i					I
      *  @param  int		    $dateSelector      	1=Show also date range input fields
      *  @param  string	    $seller            	Object of seller third party
@@ -2443,7 +2443,7 @@ abstract class CommonObject
      *  @param	HookManager	$hookmanager		Hook manager
      *  @return	void
 	 */
-	function printObjectLine($action,$line,$var=true,$num=0,$i=0,$dateSelector=0,$seller,$buyer,$selected=0,$hookmanager=false)
+	function printObjectLine($action,$line,$var,$num,$i,$dateSelector,$seller,$buyer,$selected=0,$hookmanager=false)
 	{
 		global $conf,$langs,$user;
 		global $form,$bc,$bcdd;

htdocs/core/class/genericobject.class.php

@@ -35,7 +35,7 @@ class GenericObject extends CommonObject
 	/**
 	 *	Constructor
 	 *
-	 *  @param		DoliDB		$DB      Database handler
+	 *  @param		DoliDB		$db      Database handler
 	 */
 	function __construct($db)
 	{

htdocs/core/class/hookmanager.class.php

@@ -44,7 +44,7 @@ class HookManager
 	/**
 	 * Constructor
 	 *
-	 * @param	DoliDB	$DB		Handler acces base de donnees
+	 * @param	DoliDB		$db		Handler acces base de donnees
 	 */
 	function __construct($db)
 	{

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

@@ -389,7 +389,7 @@ class Form
      *	Show a text with a picto and a tooltip on picto
      *
      *	@param	string	$text				Text to show
-     *	@param  string	$htmltooltip     	Content of tooltip
+     *	@param  string	$htmltext	     	Content of tooltip
      *	@param	int		$direction			1=Icon is after text, -1=Icon is before text, 0=no icon
      * 	@param	string	$type				Type of picto (info, help, warning, superadmin...)
      *  @param  string	$extracss           Add a CSS style to td tags
@@ -651,7 +651,7 @@ class Form
      *	@param	int		$showempty		Add an empty field
      * 	@param	int		$showtype		Show third party type in combolist (customer, prospect or supplier)
      * 	@param	int		$forcecombo		Force to use combo box
-     	 @param	array	$event			Event options
+     *  @param	array	$event			Event options
      * 	@return	string					HTML string with
      */
     function select_company($selected='',$htmlname='socid',$filter='',$showempty=0, $showtype=0, $forcecombo=0, $event=array())
@@ -811,7 +811,7 @@ class Form
      *	@param	int		$socid      	Id ot third party or 0 for all
      *	@param  string	$selected   	Id contact pre-selectionne
      *	@param  string	$htmlname  	    Name of HTML field ('none' for a not editable field)
-     *	@param  int		$show_empty     0=no empty value, 1=add an empty value
+     *	@param  int		$showempty     	0=no empty value, 1=add an empty value
      *	@param  string	$exclude        List of contacts id to exclude
      *	@param	string	$limitto		Disable answers that are not id in this array list
      *	@param	string	$showfunction   Add function into label
@@ -1055,6 +1055,7 @@ class Form
      *  @param		int			$status					-1=Return all products, 0=Products not on sell, 1=Products on sell
      *  @param		int			$finished				2=all, 1=finished, 0=raw material
      *  @param		string		$selected_input_value	Value of preselected input text (with ajax)
+     *  @param		int			$hide_label				Hide label
      *  @return		void
      */
     function select_produits($selected='',$htmlname='productid',$filtertype='',$limit=20,$price_level=0,$status=1,$finished=2,$selected_input_value='',$hidelabel=0)
@@ -1312,7 +1313,7 @@ class Form
      *	@param  string	$filtre			For a SQL filter
      *	@return	void
      */
-    function select_produits_fournisseurs($socid,$selected='',$htmlname='productid',$filtertype='',$filtre)
+    function select_produits_fournisseurs($socid,$selected='',$htmlname='productid',$filtertype='',$filtre='')
     {
         global $langs,$conf;
         global $price_level, $status, $finished;
@@ -1576,7 +1577,7 @@ class Form
      *    @param    int		$showempty         	Add an empty field
      *    @return	void
      */
-    function select_address($selected='', $socid, $htmlname='address_id',$showempty=0)
+    function select_address($selected, $socid, $htmlname='address_id',$showempty=0)
     {
         // On recherche les utilisateurs
         $sql = "SELECT a.rowid, a.label";
@@ -2064,6 +2065,7 @@ class Form
      *    @param    string	$select_name		HTML field name
      *    @param    int		$maxlength      	Maximum length for labels
      *    @param    int		$excludeafterid 	Exclude all categories after this leaf in category tree.
+     *    @return	void
      */
     function select_all_categories($type, $selected='', $select_name="", $maxlength=64, $excludeafterid=0)
     {
@@ -2606,7 +2608,7 @@ class Form
      *
      *  @param  string	$page        	Page URL where form is shown
      *  @param  int		$selected    	Value pre-selected
-     *	@param  string	$htmlname    	Nom du formulaire select. Si none, non modifiable
+     *	@param  string	$htmlname    	Nom du formulaire select. Si 'none', non modifiable. Example 'remise_id'.
      *	@param	int		$socid			Third party id
      * 	@param	float	$amount			Total amount available
      * 	@param	string	$filter			SQL filter on discounts
@@ -2614,7 +2616,7 @@ class Form
      *  @param  string	$more           More string to add
      *  @return	void
      */
-    function form_remise_dispo($page, $selected='', $htmlname='remise_id', $socid, $amount, $filter='', $maxvalue=0, $more='')
+    function form_remise_dispo($page, $selected, $htmlname, $socid, $amount, $filter='', $maxvalue=0, $more='')
     {
         global $conf,$langs;
         if ($htmlname != "none")
@@ -2855,7 +2857,7 @@ class Form
      *  @param  Societe	$societe_acheteuse  Object societe acheteuse
      *  @param  int		$idprod             Id product
      *  @param  int		$info_bits          Miscellaneous information on line
-     *  @param  type               			''=Unknown, 0=Product, 1=Service (Used if idprod not defined)
+     *  @param  string	$type      			''=Unknown, 0=Product, 1=Service (Used if idprod not defined)
      *  						            Si vendeur non assujeti a TVA, TVA par defaut=0. Fin de regle.
      *              						Si le (pays vendeur = pays acheteur) alors la TVA par defaut=TVA du produit vendu. Fin de regle.
      *              						Si (vendeur et acheteur dans Communaute europeenne) et bien vendu = moyen de transports neuf (auto, bateau, avion), TVA par defaut=0 (La TVA doit etre paye par l'acheteur au centre d'impots de son pays et non au vendeur). Fin de regle.
@@ -3428,7 +3430,7 @@ class Form
     /**
      *	Return an html string with a select combo box to choose yes or no
      *
-     *	@param	string	$name			Name of html select field
+     *	@param	string	$htmlname		Name of html select field
      *	@param	string	$value			Pre-selected value
      *	@param	int		$option			0 return yes/no, 1 return 1/0
      *	@param	bool	$disabled		true or false

htdocs/core/class/html.formfile.class.php

@@ -66,7 +66,7 @@ class FormFile
 
         if ($conf->global->MAIN_USE_JQUERY_FILEUPLOAD)
         {
-            return $this->_form_ajaxfileupload($object);
+            return $this->_formAjaxFileUpload($object);
         }
         else
         {
@@ -779,7 +779,7 @@ class FormFile
      *    @param	Object	$object		Object to use
      *    @return	void
      */
-    private function _form_ajaxfileupload($object)
+    private function _formAjaxFileUpload($object)
     {
         global $langs;
 

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

@@ -71,7 +71,7 @@ class FormMail
     /**
      *	Constructor
      *
-     *  @param	DoliDB	$DB      Database handler
+     *  @param	DoliDB	$db      Database handler
      */
     function FormMail($db)
     {

htdocs/core/class/infobox.class.php

@@ -30,6 +30,7 @@ class InfoBox
     /**
      *  Return array of boxes qualified for area and user
      *
+     *  @param	DoliDB	$db				Database handler
      *  @param	string	$mode			'available' or 'activated'
      *  @param	string	$zone			Name or area (-1 for all, 0 for Homepage, 1 for xxx, ...)
      *  @param  User    $user	  		Objet user to filter (used only if $zone >= 0)
@@ -140,6 +141,7 @@ class InfoBox
     /**
      *  Save order of boxes for area and user
      *
+     *  @param	DoliDB	$db				Database handler
      *  @param	string	$zone       	Name of area (0 for Homepage, ...)
      *  @param  string  $boxorder   	List of boxes with correct order 'A:123,456,...-B:789,321...'
      *  @param  int     $userid     	Id of user

htdocs/core/class/interfaces.class.php

@@ -50,7 +50,7 @@ class Interfaces
      *   @param		string		$action     Trigger event code
      *   @param     Object		$object     Objet concern
      *   @param     User		$user       Objet user
-     *   @param     Lang		$lang       Objet lang
+     *   @param     Lang		$langs      Objet lang
      *   @param     Conf		$conf       Objet conf
      *   @return    int         			Nb of triggers ran if no error, -Nb of triggers with errors otherwise.
      */

htdocs/core/class/ldap.class.php

@@ -1012,6 +1012,7 @@ class Ldap
 	 *	Required by Active Directory
 	 *
 	 *	@param	string		$hex
+	 *	@return	string		little endian
 	 */
 	function littleEndian($hex)
 	{
@@ -1027,6 +1028,7 @@ class Ldap
 	 *	Required by Active Directory
 	 *
 	 * 	@param	string		$ldapuser		Login de l'utilisateur
+	 * 	@return	string						Sid
 	 */
 	function getObjectSid($ldapUser)
 	{
@@ -1056,7 +1058,7 @@ class Ldap
 
 			if (!$entry)
 			{
-				// Si pas de r<EFBFBD>sultat on cherche dans le domaine
+				// Si pas de resultat on cherche dans le domaine
 				$searchDN = $this->domain;
 				$i++;
 			}
@@ -1109,8 +1111,8 @@ class Ldap
 	 *	car conflit majuscule-minuscule. A n'utiliser que pour les pages
 	 *	'Fiche LDAP' qui affiche champ lisibles par defaut.
 	 *
-	 * 	@param 		checkDn			DN de recherche (Ex: ou=users,cn=my-domain,cn=com)
+	 * 	@param	string	$checkDn		DN de recherche (Ex: ou=users,cn=my-domain,cn=com)
-	 * 	@param 		filter			Filtre de recherche (ex: (sn=nom_personne) )
+	 * 	@param 	string	$filter			Filtre de recherche (ex: (sn=nom_personne) )
 	 *	@return	array					Tableau des reponses (cle en minuscule-valeur)
 	 */
 	function search($checkDn, $filter)

htdocs/core/class/rssparser.class.php

@@ -25,18 +25,18 @@ class RssParser
     var $db;
     var $error;
 
-    protected $_format='';
+    private $_format='';
-    protected $_urlRSS;
+    private $_urlRSS;
-    protected $_language;
+    private $_language;
-    protected $_generator;
+    private $_generator;
-    protected $_copyright;
+    private $_copyright;
-    protected $_lastbuilddate;
+    private $_lastbuilddate;
-    protected $_imageurl;
+    private $_imageurl;
-    protected $_link;
+    private $_link;
-    protected $_title;
+    private $_title;
-    protected $_description;
+    private $_description;
-    protected $_lastfetchdate;    // Last successful fetch
+    private $_lastfetchdate;    // Last successful fetch
-    protected $_rssarray=array();
+    private $_rssarray=array();
 
     /**
      * getFormat

htdocs/core/filemanagerdol/browser/default/frmactualfolder.php

@@ -19,7 +19,8 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 
-require('../../../../main.inc.php'); ?>
+require('../../../../main.inc.php');
+?>
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 <!--
  * FCKeditor - The text editor for Internet - http://www.fckeditor.net

htdocs/core/filemanagerdol/browser/default/frmcreatefolder.php

@@ -19,7 +19,8 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 
-require('../../../../main.inc.php'); ?>
+require('../../../../main.inc.php');
+?>
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 <!--
  * FCKeditor - The text editor for Internet - http://www.fckeditor.net

htdocs/core/filemanagerdol/browser/default/frmfolders.php

@@ -19,7 +19,8 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 
-require('../../../../main.inc.php'); ?>
+require('../../../../main.inc.php');
+?>
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 <!--
  * FCKeditor - The text editor for Internet - http://www.fckeditor.net

htdocs/core/filemanagerdol/browser/default/frmresourceslist.php

@@ -19,7 +19,8 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 
-require('../../../../main.inc.php'); ?>
+require('../../../../main.inc.php');
+?>
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 <!--
  * FCKeditor - The text editor for Internet - http://www.fckeditor.net

htdocs/core/filemanagerdol/browser/default/frmupload.php

@@ -19,7 +19,8 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 
-require('../../../../main.inc.php'); ?>
+require('../../../../main.inc.php');
+?>
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 <!--
  * FCKeditor - The text editor for Internet - http://www.fckeditor.net

htdocs/core/filemanagerdol/connectors/php/basexml.php

@@ -23,6 +23,11 @@
  * connector.
  */
 
+/**
+ * SetXmlHeaders
+ *
+ * @return	void
+ */
 function SetXmlHeaders()
 {
 	ob_end_clean();

htdocs/core/filemanagerdol/connectors/php/phpcompat.php

@@ -10,8 +10,7 @@ if ( !isset( $_FILES ) ) {
     $_FILES = $HTTP_POST_FILES ;
 }
 
-if ( !defined( 'DIRECTORY_SEPARATOR' ) ) {
+if (! defined('DIRECTORY_SEPARATOR'))
-    define( 'DIRECTORY_SEPARATOR',
+{
-        strtoupper(substr(PHP_OS, 0, 3) == 'WIN') ? '\\' : '/'
+    define('DIRECTORY_SEPARATOR', strtoupper(substr(PHP_OS, 0, 3) == 'WIN') ? '\\' : '/');
-    );
 }

htdocs/core/lib/pdf.lib.php

@@ -667,8 +667,8 @@ function pdf_pagefoot(&$pdf,$outputlangs,$paramfreetext,$fromcompany,$marge_bass
  *	@param	PDF			&$pdf				Object PDF
  *	@param	object		$object				Object
  *	@param  Translate	$outputlangs		Object lang
- *	@param  int			$curx				X
+ *	@param  int			$posx				X
- *	@param  int			$cury				Y
+ *	@param  int			$posy				Y
  *	@param	int			$align				Align
  *	@param	string		$default_font_size	Font size
  *	@param	HookManager	$hookmanager		Hook manager object

htdocs/core/login/functions_myopenid.php

@@ -242,7 +242,6 @@ class SimpleOpenID
     /**
      * GetIdentity
      *
-     * @param	string	$a		Server
      * @return	void
      */
     function GetIdentity()
@@ -253,7 +252,6 @@ class SimpleOpenID
     /**
      * SetOpenIDServer
      *
-     * @param	string	$a		Server
      * @return	void
      */
     function GetError()
@@ -265,7 +263,8 @@ class SimpleOpenID
     /**
      * ErrorStore
      *
-     * @param	string	$a		Server
+     * @param	string	$code		Code
+     * @param	string	$desc		Description
      * @return	void
      */
     function ErrorStore($code, $desc = null)
@@ -280,14 +279,16 @@ class SimpleOpenID
     /**
      * IsError
      *
-     * @param	string	$a		Server
      * @return	void
      */
     function IsError()
     {
-        if (count($this->error) > 0){
+        if (count($this->error) > 0)
+        {
             return true;
-        }else{
+        }
+        else
+        {
             return false;
         }
     }
@@ -295,7 +296,7 @@ class SimpleOpenID
     /**
      * splitResponse
      *
-     * @param	string	$a		Server
+     * @param	string	$response		Server
      * @return	void
      */
     function splitResponse($response)
@@ -315,7 +316,7 @@ class SimpleOpenID
     /**
      * OpenID_Standarize
      *
-     * @param	string	$a		Server
+     * @param	string	$openidçidentity		Server
      * @return	void
      */
     function OpenID_Standarize($openid_identity = null)
@@ -434,7 +435,6 @@ class SimpleOpenID
     /**
      * GetRedirectURL
      *
-     * @param	string	$a		Server
      * @return	void
      */
     function GetRedirectURL()
@@ -459,7 +459,6 @@ class SimpleOpenID
     /**
      * Redirect
      *
-     * @param	string	$a		Server
      * @return	void
      */
     function Redirect()
@@ -480,7 +479,6 @@ class SimpleOpenID
     /**
      * ValidateWithServer
      *
-     * @param	string	$a		Server
      * @return	void
      */
     function ValidateWithServer()

htdocs/core/menus/smartphone/smartphone.lib.php

@@ -26,10 +26,11 @@
 /**
  * Core function to output top menu smartphone
  *
- * @param $db
+ * @param 	DoliDB		$db				Database handler
- * @param $atarget
+ * @param 	string		$atarget		Target
- * @param $type_user     0=Internal,1=External,2=All
+ * @param 	int			$type_user     	0=Internal,1=External,2=All
- * @param $limitmenuto	 To limit menu to a top or left menu value
+ * @param 	string		$limitmenuto	To limit menu to a top or left menu value
+ * @return	void
  */
 function print_smartphone_menu($db,$atarget,$type_user,$limitmenuto)
 {
@@ -141,34 +142,66 @@ function print_smartphone_menu($db,$atarget,$type_user,$limitmenuto)
 	print "\n";
 }
 
+/**
+ * Output menu entry
+ *
+ * @param	string	$theme		Theme
+ * @return	void
+ */
 function print_start_menu_array($theme='c')
 {
 	print '<ul data-role="listview" data-theme="'.$theme.'">';
 	print "\n";
 }
 
+/**
+ * Output start submenu entry
+ *
+ * @return	void
+ */
 function print_start_submenu_array()
 {
 	print '<ul>';
 	print "\n";
 }
 
+/**
+ * Output start menu entry
+ *
+ * @return	void
+ */
 function print_start_menu_entry()
 {
 	print '<li>';
 }
 
+/**
+ * Output menu entry
+ *
+ * @param	string	$text		Text
+ * @return	void
+ */
 function print_text_menu_entry($text)
 {
 	print $text;
 }
 
+/**
+ * Output end menu entry
+ *
+ * @return	void
+ */
 function print_end_menu_entry()
 {
 	print '</li>';
 	print "\n";
 }
 
+/**
+ * Output end menu
+ *
+ * @return	void
+ */
 function print_end_menu()
 {
 	print '</ul>';

htdocs/core/menus/smartphone/smartphone_backoffice.php

@@ -25,8 +25,8 @@
 /**
  *	Class to manage smartphone menu smartphone (for internal users)
  */
-class MenuSmart {
+class MenuSmart
-
+{
 	var $db;
 	var $require_left=array("smartphone_backoffice");     // Si doit etre en phase avec un gestionnaire de menu particulier
 	var $hideifnotallowed=0;						// Put 0 for back office menu, 1 for front office menu

htdocs/core/menus/smartphone/smartphone_frontoffice.php

@@ -23,10 +23,10 @@
 
 
 /**
- *      \class      MenuSmart
+ *	Class to manage smartphone menu smartphone (for external users)
- *	    \brief      Class to manage smartphone menu smartphone (for external users)
  */
-class MenuSmart {
+class MenuSmart
+{
 
 	var $require_left=array("smartphone_frontoffice");    // Si doit etre en phase avec un gestionnaire de menu particulier
 	var $hideifnotallowed=1;						// Put 0 for back office menu, 1 for front office menu
@@ -36,7 +36,7 @@ class MenuSmart {
 	/**
 	 *	Constructor
 	 *
-	 *  @param		DoliDB		$DB      Database handler
+	 *  @param		DoliDB		$db      Database handler
 	 */
 	function MenuSmart($db)
 	{
@@ -47,7 +47,7 @@ class MenuSmart {
 	/**
 	 *    Show menu
 	 *
-	 *    @param		limitmenuto		To limit menu to a top or left menu value
+	 *    @param	string		$limitmenuto		To limit menu to a top or left menu value
 	 */
 	function showmenu($limitmenuto)
 	{

htdocs/core/menus/standard/auguria.lib.php

@@ -108,7 +108,11 @@ function print_auguria_menu($db,$atarget,$type_user)
 }
 
 
-
+/**
+ * Output start menu entry
+ *
+ * @return	void
+ */
 function print_start_menu_array_auguria()
 {
 	global $conf;
@@ -116,6 +120,12 @@ function print_start_menu_array_auguria()
 	else print '<ul class="tmenu">';
 }
 
+/**
+ * Output menu entry
+ *
+ * @param	string	$idsel		Text
+ * @return	void
+ */
 function print_start_menu_entry_auguria($idsel)
 {
 	global $conf;
@@ -123,6 +133,12 @@ function print_start_menu_entry_auguria($idsel)
 	else print '<li class="tmenu" id="mainmenutd_'.$idsel.'">';
 }
 
+/**
+ * Output menu entry
+ *
+ * @param	string	$text		Text
+ * @return	void
+ */
 function print_text_menu_entry_auguria($text)
 {
 	global $conf;
@@ -131,6 +147,11 @@ function print_text_menu_entry_auguria($text)
 	print '</span>';
 }
 
+/**
+ * Output end menu entry
+ *
+ * @return	void
+ */
 function print_end_menu_entry_auguria()
 {
 	global $conf;
@@ -139,6 +160,11 @@ function print_end_menu_entry_auguria()
 	print "\n";
 }
 
+/**
+ * Output menu array
+ *
+ * @return	void
+ */
 function print_end_menu_array_auguria()
 {
 	global $conf;

htdocs/core/menus/standard/eldy.lib.php

@@ -511,6 +511,12 @@ function print_start_menu_array()
 	else print '<ul class="tmenu">';
 }
 
+/**
+ * Output start menu entry
+ *
+ * @param	string	$idsel		Text
+ * @return	void
+ */
 function print_start_menu_entry($idsel)
 {
 	global $conf;
@@ -518,6 +524,12 @@ function print_start_menu_entry($idsel)
 	else print '<li class="tmenu" id="mainmenutd_'.$idsel.'">';
 }
 
+/**
+ * Output menu entry
+ *
+ * @param	string	$text		Text
+ * @return	void
+ */
 function print_text_menu_entry($text)
 {
 	global $conf;
@@ -526,6 +538,11 @@ function print_text_menu_entry($text)
 	print '</span>';
 }
 
+/**
+ * Output end menu entry
+ *
+ * @return	void
+ */
 function print_end_menu_entry()
 {
 	global $conf;
@@ -534,6 +551,11 @@ function print_end_menu_entry()
 	print "\n";
 }
 
+/**
+ * Output menu array
+ *
+ * @return	void
+ */
 function print_end_menu_array()
 {
 	global $conf;

htdocs/core/menus/standard/empty.php

@@ -71,7 +71,11 @@ class MenuTop
 
 }
 
-
+/**
+ * Output menu entry
+ *
+ * @return	void
+ */
 function print_start_menu_array_empty()
 {
 	global $conf;
@@ -79,6 +83,12 @@ function print_start_menu_array_empty()
 	else print '<ul class="tmenu">';
 }
 
+/**
+ * Output start menu entry
+ *
+ * @param	string	$idsel		Text
+ * @return	void
+ */
 function print_start_menu_entry_empty($idsel)
 {
 	global $conf;
@@ -86,6 +96,12 @@ function print_start_menu_entry_empty($idsel)
 	else print '<li class="tmenu" id="mainmenutd_'.$idsel.'">';
 }
 
+/**
+ * Output menu entry
+ *
+ * @param	string	$text		Text
+ * @return	void
+ */
 function print_text_menu_entry_empty($text)
 {
 	global $conf;
@@ -94,6 +110,11 @@ function print_text_menu_entry_empty($text)
 	print '</span>';
 }
 
+/**
+ * Output end menu entry
+ *
+ * @return	void
+ */
 function print_end_menu_entry_empty()
 {
 	global $conf;
@@ -102,6 +123,11 @@ function print_end_menu_entry_empty()
 	print "\n";
 }
 
+/**
+ * Output menu array
+ *
+ * @return	void
+ */
 function print_end_menu_array_empty()
 {
 	global $conf;

htdocs/core/modules/expedition/doc/pdf_expedition_merou.modules.php

@@ -74,8 +74,8 @@ Class pdf_expedition_merou extends ModelePdfExpedition
 	/**
 	 *	Fonction generant le document sur le disque
 	 *
-	 *	@param	    object			Objet expedition a generer (ou id si ancienne methode)
+	 *	@param	Object		&$object			Objet expedition a generer (ou id si ancienne methode)
-	 *	@param		outputlangs		Lang output object
+	 *	@param	Translate	$outputlangs	Lang output object
 	 * 	@return	int     					1=ok, 0=ko
 	 */
 	function write_file(&$object, $outputlangs)

htdocs/core/modules/expedition/doc/pdf_expedition_rouget.modules.php

@@ -76,7 +76,7 @@ Class pdf_expedition_rouget extends ModelePdfExpedition
 	/**
 	 *	Fonction generant le document sur le disque
 	 *
-	 *	@param	Object		$object			Objet expedition a generer (ou id si ancienne methode)
+	 *	@param	Object		&$object			Objet expedition a generer (ou id si ancienne methode)
 	 *	@param	Translate	$outputlangs	Lang output object
 	 * 	@return	int     					1=ok, 0=ko
 	 */

htdocs/core/modules/expedition/mod_expedition_ribera.php

@@ -120,7 +120,7 @@ class mod_expedition_ribera extends ModelNumRefExpedition
 	 *  Return next free value
 	 *
 	 *	@param	Societe		$objsoc     Third party object
-	 *	@param	Object		$shipment	Shipment object
+	 *	@param	Object		$objforref	Shipment object
 	 *	@return string      			Next free value
 	 */
     function expedition_get_num($objsoc,$objforref)

htdocs/core/modules/expedition/mod_expedition_safor.php

@@ -132,7 +132,7 @@ class mod_expedition_safor extends ModelNumRefExpedition
 	 *  Return next free value
 	 *
 	 *	@param	Societe		$objsoc     Third party object
-	 *	@param	Object		$shipment	Shipment object
+	 *	@param	Object		$objforref	Shipment object
 	 *	@return string      			Next free value
 	 */
 	function expedition_get_num($objsoc,$objforref)

htdocs/core/modules/facture/doc/pdf_oursin.modules.php

@@ -746,6 +746,7 @@ class pdf_oursin extends ModelePDFFactures
 	 *   @param		string		$tab_top		Top position of table
 	 *   @param		string		$tab_height		Height of table (rectangle)
 	 *   @param		int			$nexY			Y
+	 *   @param		Object		$object			Object
 	 *   @param		Translate	$outputlangs	Langs object
 	 *   @return	void
 	 */

htdocs/core/modules/facture/mod_facture_mercure.php

@@ -110,9 +110,9 @@ class mod_facture_mercure extends ModeleNumRefFactures
     /**
      * Return next value
      *
-     * @param      objsoc      Object third party
+     * @param	Societe		$objsoc     Object third party
-     * @param      facture		Object invoice
+     * @param   Facture		$facture	Object invoice
-     * @param      mode        'next' for next value or 'last' for last value
+     * @param   string		$mode       'next' for next value or 'last' for last value
      * @return  string      			Value if OK, 0 if KO
      */
     function getNextValue($objsoc,$facture,$mode='next')

htdocs/core/modules/facture/mod_facture_terre.php

@@ -114,11 +114,12 @@ class mod_facture_terre extends ModeleNumRefFactures
 		return true;
 	}
 
-	/**     Return next value not used or last value used
+	/**
+	 * Return next value not used or last value used
 	 *
-	 *      @param     objsoc		Object third party
+	 * @param	Societe		$objsoc		Object third party
-	 *      @param     facture		Object invoice
+	 * @param   Facture		$facture	Object invoice
-     *      @param     mode         'next' for next value or 'last' for last value
+     * @param   string		$mode       'next' for next value or 'last' for last value
 	 * @return  string       			Value
 	 */
 	function getNextValue($objsoc,$facture,$mode='next')

htdocs/core/modules/facture/modules_facture.php

@@ -116,9 +116,9 @@ abstract class ModeleNumRefFactures
 	/**
 	 * Renvoi prochaine valeur attribuee
 	 *
-	 * @param     objsoc		Objet societe
+	 * @param	Societe		$objsoc		Objet societe
-	 * @param     facture		Objet facture
+	 * @param   Facture		$facture	Objet facture
-	 * @return    string      Valeur
+	 * @return  string      			Value
 	 */
 	function getNextValue($objsoc,$facture)
 	{

htdocs/core/modules/livraison/mod_livraison_saphir.php

@@ -143,7 +143,7 @@ class mod_livraison_saphir extends ModeleNumRefDeliveryOrder
 	 *  Return next free ref
 	 *
      *  @param	Societe		$objsoc      	Object thirdparty
-     *  @param  Object		$livraison		Objet livraison
+     *  @param  Object		$object			Objet livraison
      *  @return string      				Texte descripif
      */
     function livraison_get_num($objsoc=0,$object='')

htdocs/core/modules/societe/mod_codeclient_elephant.php

@@ -152,10 +152,11 @@ class mod_codeclient_elephant extends ModeleThirdPartyCode
 		return $examplecust.'<br>'.$examplesup;
 	}
 
-	/**		Return next value
+	/**
+	 * Return next value
 	 *
-	 *     	@param      objsoc      Object third party
+	 * @param	Societe		$objsoc     Object third party
-	 *	    @param      $type       Client ou fournisseur (0:customer, 1:supplier)
+	 * @param  	int		    $type       Client ou fournisseur (0:customer, 1:supplier)
 	 * @return 	string      			Value if OK, '' if module not configured, <0 if KO
 	 */
 	function getNextValue($objsoc=0,$type=-1)

htdocs/core/modules/societe/mod_codeclient_monkey.php

@@ -247,7 +247,7 @@ class mod_codeclient_monkey extends ModeleThirdPartyCode
 	 *	Renvoi si un code respecte la syntaxe
 	 *
 	 *	@param	string		$code		Code a verifier
-*	 *	@return	int						0 si OK, <0 si KO
+	 *	@return	int						0 si OK, <0 si KO
 	 */
 	function verif_syntax($code)
 	{

htdocs/core/modules/societe/mod_codecompta_aquarium.php

@@ -100,9 +100,9 @@ class mod_codecompta_aquarium extends ModeleAccountancyCode
 	/**
 	 *  Set accountancy account code for a third party into this->code
 	 *
-	 *  @param      db              Database handler
+	 *  @param	DoliDB		$db             Database handler
-	 *  @param      societe         Third party object
+	 *  @param  Societe		$societe        Third party object
-	 *  @param      type			'customer' or 'supplier'
+	 *  @param  string		$type			'customer' or 'supplier'
 	 *  @return	int							>=0 if OK, <0 if KO
 	 */
 	function get_code($db, $societe, $type)
@@ -138,10 +138,10 @@ class mod_codecompta_aquarium extends ModeleAccountancyCode
 	/**
 	 *  Return if a code is available
 	 *
-	 *	@param		db			Database handler
+	 *	@param	DoliDB		$db			Database handler
-	 * 	@param		code		Code of third party
+	 * 	@param	string		$code		Code of third party
-	 * 	@param		societe		Object third party
+	 * 	@param	Societe		$societe	Object third party
-	 * 	@param		type		'supplier' or 'customer'
+	 * 	@param	string		$type		'supplier' or 'customer'
 	 *	@return	int						0 if OK but not available, >0 if OK and available, <0 if KO
 	 */
 	function verif($db, $code, $societe, $type)

htdocs/core/modules/supplier_invoice/pdf/pdf_canelle.modules.php

@@ -115,8 +115,9 @@ class pdf_canelle extends ModelePDFSuppliersInvoices
 
 	/**
      *      Write the invoice as a document onto disk
-     *      @param      object          Object invoice to build (or id if old method)
+     *
-     *      @param      outputlangs     Lang object for output language
+     *      @param	Object		$object         Object invoice to build (or id if old method)
+     *      @param  Translate	$outputlangs    Lang object for output language
      *      @return int             			1=OK, 0=KO
 	 */
 	function write_file($object,$outputlangs='')

htdocs/core/triggers/interface_20_all_Logevents.class.php

@@ -93,12 +93,12 @@ class InterfaceLogevents
      *      Function called when a Dolibarrr business event is done.
      *      All functions "run_trigger" are triggered if file is inside directory htdocs/core/triggers
      *
-     *      @param      action      Code de l'evenement
+     *      @param	string		$action		Event action code
-     *      @param      object      Objet concerne
+     *      @param  Object		$object     Object
-     *      @param      user        Objet user
+     *      @param  User		$user       Object user
-     *      @param      langs       Objet langs
+     *      @param  Translate	$langs      Object langs
-     *      @param      conf        Objet conf
+     *      @param  conf		$conf       Object conf
-     *      @param      entity      Value for instance of data (Always 1 except if module MultiCompany is installed)
+     *      @param  string		$entity     Value for instance of data (Always 1 except if module MultiCompany is installed)
      *      @return int         			<0 if KO, 0 if no triggered ran, >0 if OK
      */
     function run_trigger($action,$object,$user,$langs,$conf,$entity=1)

htdocs/core/triggers/interface_20_modPaypal_PaypalWorkflow.class.php

@@ -88,12 +88,12 @@ class InterfacePaypalWorkflow
      *  Fonction appelee lors du declenchement d'un evenement Dolibarr.
      *  D'autres fonctions run_trigger peuvent etre presentes dans core/triggers
      *
-     *  @param	string			$action     Code de l'evenement
+     *      @param	string		$action		Event action code
-     *  @param  CommonObject	$object     Objet concerne
+     *      @param  Object		$object     Object
-     *  @param  User			$user       Objet user
+     *      @param  User		$user       Object user
-     *  @param  Translate		$langs      Objet lang
+     *      @param  Translate	$langs      Object langs
-     *  @param  Conf			$conf       Objet conf
+     *      @param  conf		$conf       Object conf
-     *  @return int         				<0 if fatal error, 0 si nothing done, >0 if ok
+     *      @return int         			<0 if KO, 0 if no triggered ran, >0 if OK
      */
 	function run_trigger($action,$object,$user,$langs,$conf)
     {

htdocs/core/triggers/interface_20_modWorkflow_WorkflowManager.class.php

@@ -90,12 +90,13 @@ class InterfaceWorkflowManager
      *      Function called when a Dolibarrr business event is done.
      *      All functions "run_trigger" are triggered if file is inside directory htdocs/core/triggers
      *
-     *      @param      action      Event code (COMPANY_CREATE, PROPAL_VALIDATE, ...)
+     *      @param	string		$action		Event action code
-     *      @param      object      Object action is done on
+     *      @param  Object		$object     Object
-     *      @param      user        Object user
+     *      @param  User		$user       Object user
-     *      @param      langs       Object langs
+     *      @param  Translate	$langs      Object langs
-     *      @param      conf        Object conf
+     *      @param  conf		$conf       Object conf
-     *      @return     int         <0 if KO, 0 if no action are done, >0 if OK
+     *      @param  string		$entity     Value for instance of data (Always 1 except if module MultiCompany is installed)
+     *      @return int         			<0 if KO, 0 if no triggered ran, >0 if OK
      */
 	function run_trigger($action,$object,$user,$langs,$conf)
     {

htdocs/core/triggers/interface_50_modAgenda_ActionsAuto.class.php

@@ -104,12 +104,12 @@ class InterfaceActionsAuto
      *      $object->fk_element
      *      $object->elementtype
      *
-     *      @param      action      Event code (COMPANY_CREATE, PROPAL_VALIDATE, ...)
+     *      @param	string		$action		Event action code
-     *      @param      object      Object action is done on
+     *      @param  Object		$object     Object
-     *      @param      user        Object user
+     *      @param  User		$user       Object user
-     *      @param      langs       Object langs
+     *      @param  Translate	$langs      Object langs
-     *      @param      conf        Object conf
+     *      @param  conf		$conf       Object conf
-     *      @return     int         <0 if KO, 0 if no action are done, >0 if OK
+     *      @return int         			<0 if KO, 0 if no triggered ran, >0 if OK
      */
     function run_trigger($action,$object,$user,$langs,$conf)
     {

htdocs/core/triggers/interface_50_modLdap_Ldapsynchro.class.php

@@ -89,12 +89,12 @@ class InterfaceLdapsynchro
      *      Function called when a Dolibarrr business event is done.
      *      All functions "run_trigger" are triggered if file is inside directory htdocs/core/triggers
      *
-     *      @param      action      Event code (COMPANY_CREATE, PROPAL_VALIDATE, ...)
+     *      @param	string		$action		Event action code
-     *      @param      object      Object action is done on
+     *      @param  Object		$object     Object
-     *      @param      user        Object user
+     *      @param  User		$user       Object user
-     *      @param      langs       Object langs
+     *      @param  Translate	$langs      Object langs
-     *      @param      conf        Object conf
+     *      @param  conf		$conf       Object conf
-     *      @return     int         <0 if KO, 0 if no action are done, >0 if OK
+     *      @return int         			<0 if KO, 0 if no triggered ran, >0 if OK
      */
 	function run_trigger($action,$object,$user,$langs,$conf)
     {

htdocs/core/triggers/interface_50_modNotification_Notification.class.php

@@ -89,12 +89,12 @@ class InterfaceNotification
      *      Function called when a Dolibarrr business event is done.
      *      All functions "run_trigger" are triggered if file is inside directory htdocs/core/triggers
      *
-     *      @param      action      Event code (COMPANY_CREATE, PROPAL_VALIDATE, ...)
+     *      @param	string		$action		Event action code
-     *      @param      object      Object action is done on
+     *      @param  Object		$object     Object
-     *      @param      user        Object user
+     *      @param  User		$user       Object user
-     *      @param      langs       Object langs
+     *      @param  Translate	$langs      Object langs
-     *      @param      conf        Object conf
+     *      @param  conf		$conf       Object conf
-     *      @return     int         <0 if KO, 0 if no action are done, >0 if OK
+     *      @return int         			<0 if KO, 0 if no triggered ran, >0 if OK
      */
 	function run_trigger($action,$object,$user,$langs,$conf)
     {

htdocs/core/triggers/interface_90_all_Demo.class.php-NORUN

@@ -92,11 +92,12 @@ class InterfaceDemo
     /**
      *      Function called when a Dolibarrr business event is done.
      *      All functions "run_trigger" are triggered if file is inside directory htdocs/core/triggers
-     *      @param      action      Code de l'evenement
+     *
-     *      @param      object      Objet concerne
+     *      @param	string		$action		Event action code
-     *      @param      user        Objet user
+     *      @param  Object		$object     Object
-     *      @param      langs       Objet langs
+     *      @param  User		$user       Object user
-     *      @param      conf        Objet conf
+     *      @param  Translate	$langs      Object langs
+     *      @param  conf		$conf       Object conf
      *      @return int         			<0 if KO, 0 if no triggered ran, >0 if OK
      */
 	function run_trigger($action,$object,$user,$langs,$conf)

htdocs/install/upgrade2.php

@@ -806,6 +806,7 @@ function migrate_contracts_det($db,$langs,$conf)
 }
 
 /**
+ * Function to migrate links into llx_bank_url
  *
  * @param	DoliDB		$db		Database handler
  * @param	Translate	$langs	Object langs
@@ -2690,6 +2691,11 @@ function migrate_project_task_actors($db,$langs,$conf)
  * @param	DoliDB		$db				Database handler
  * @param	Translate	$langs			Object langs
  * @param	Conf		$conf			Object conf
+ * @param	string		$table			Table name
+ * @param	int			$fk_source		Id of element source
+ * @param	type		$sourcetype		Type of element source
+ * @param	int			$fk_target		Id of element target
+ * @param	type		$targettype		Type of element target
  * @return	void
  */
 function migrate_relationship_tables($db,$langs,$conf,$table,$fk_source,$sourcetype,$fk_target,$targettype)

htdocs/paypal/lib/paypal.lib.php

@@ -765,6 +765,8 @@ function deformatNVP($nvpstr)
 
 /**
  * 	Get API errors
+ *
+ * 	@return	array		Array of errors
  */
 function getApiError()
 {

htdocs/support/inc.php

@@ -50,27 +50,6 @@ if (isset($_SERVER["DOCUMENT_URI"]) && $_SERVER["DOCUMENT_URI"])
 }
 
 
-// Define syslog constants
-if (! defined('LOG_DEBUG'))
-{
-    if (function_exists("define_syslog_variables"))
-    {
-    	define_syslog_variables(); // Deprecated since php 5.3.0, syslog variables no longer need to be initialized
-    }
-    else
-    {
-    	// Pour PHP sans syslog (comme sous Windows)
-    	define('LOG_EMERG',0);
-    	define('LOG_ALERT',1);
-    	define('LOG_CRIT',2);
-    	define('LOG_ERR',3);
-    	define('LOG_WARNING',4);
-    	define('LOG_NOTICE',5);
-    	define('LOG_INFO',6);
-    	define('LOG_DEBUG',7);
-    }
-}
-
 $includeconferror='';
 
 // Define vars
@@ -135,28 +114,6 @@ if (empty($conf->db->dolibarr_main_db_cryptkey))   $conf->db->dolibarr_main_db_c
 if (empty($conf->db->user)) $conf->db->user='';
 
 
-
-// Removed magic_quotes
-if (function_exists('get_magic_quotes_gpc'))	// magic_quotes_* removed in PHP6
-{
-	if (get_magic_quotes_gpc())
-	{
-		// Forcing parameter setting magic_quotes_gpc and cleaning parameters
-		// (Otherwise he would have for each position, condition
-		// Reading stripslashes variable according to state get_magic_quotes_gpc).
-		// Off mode (recommended, you just do $db->escape when an insert / update.
-		function stripslashes_deep($value)
-		{
-			return (is_array($value) ? array_map('stripslashes_deep', $value) : stripslashes($value));
-		}
-		$_GET     = array_map('stripslashes_deep', $_GET);
-		$_POST    = array_map('stripslashes_deep', $_POST);
-		$_COOKIE  = array_map('stripslashes_deep', $_COOKIE);
-		$_REQUEST = array_map('stripslashes_deep', $_REQUEST);
-		@set_magic_quotes_runtime(0);
-	}
-}
-
 // Defini objet langs
 $langs = new Translate('..',$conf);
 if (GETPOST('lang')) $langs->setDefaultLang(GETPOST('lang'));
@@ -257,16 +214,4 @@ function pFooter($nonext=0,$setuplang='')
 	print '</html>'."\n";
 }
 
-/**
- * Output a text into a log file
- *
- * @param	string	$message		Message to show
- * @param   string	$level			Log level
- */
-function dolibarr_support_syslog($message, $level=LOG_DEBUG)
-{
-	if (! defined('LOG_DEBUG')) define('LOG_DEBUG',6);
-	dol_syslog($message,$level);
-}
-
 ?>

htdocs/support/index.php

@@ -154,7 +154,7 @@ print '</td></tr></table>';
 
 print '</td>';
 print '</tr><tr>';
-$urlwiki='http://wiki.dolibarr.org/index.php/List_of_OpenSource_Software_companies_and_freelancers';
+$urlwiki='http://wiki.dolibarr.org/index.php/List of Dolibarr partners and providers';
 print '<td align="center" valign="top">';
 print '<table class="nocellnopadd">';
 /*print '<tr><td align="center" valign="top">';
@@ -190,7 +190,7 @@ print '</td></tr></table>';
 
 print '</td>';
 print '</tr><tr>';
-$urlwiki='http://wiki.dolibarr.org/index.php/List_of_OpenSource_Software_companies_and_freelancers';
+$urlwiki='http://wiki.dolibarr.org/index.php/List of Dolibarr partners and providers';
 print '<td align="center" valign="top">';
 print '<table class="nocellnopadd">';
 /*print '<tr><td align="center" valign="top">';