From 74b0053dcc70394e6364ccec352f7e8e9cf48688 Mon Sep 17 00:00:00 2001
From: Laurent Destailleur <eldy@users.sourceforge.net>
Date: Mon, 29 Aug 2011 21:26:42 +0000
Subject: [PATCH] Doxygen

---
 htdocs/lib/functions.lib.php           | 21 ++++++++++-----------
 htdocs/societe/class/societe.class.php | 24 ++++++++++++++++--------
 2 files changed, 26 insertions(+), 19 deletions(-)

diff --git a/htdocs/lib/functions.lib.php b/htdocs/lib/functions.lib.php
index a8db6ddd81b..062b8992e93 100644
--- a/htdocs/lib/functions.lib.php
+++ b/htdocs/lib/functions.lib.php
@@ -3898,19 +3898,18 @@ function dol_htmloutput_errors($mesgstring='', $mesgarray='', $keepembedded=0)
 }
 
 /**
- * 	Advanced sort array by second index function, which produces
- *	ascending (default) or descending output and uses optionally
- *	natural case insensitive sorting (which can be optionally case
- *	sensitive as well).
+ * 	Advanced sort array by second index function, which produces ascending (default)
+ *  or descending output and uses optionally natural case insensitive sorting (which
+ *  can be optionally case sensitive as well).
  *
- *  @param      array           	Array to sort
- *  @param      index
- *  @param      order
- *  @param      natsort
- *  @param      case_sensitive		Sort is case sensitive
- *  @return     Sorted array
+ *  @param      array		$array      		Array to sort
+ *  @param      string		$index				Key in array to use for sorting criteria
+ *  @param      int			$order				Sort order
+ *  @param      int			$natsort			1=use "natural" sort (natsort), 0=use "standard sort (asort)
+ *  @param      int			$case_sensitive		1=sort is case sensitive, 0=not case sensitive
+ *  @return     array							Sorted array
  */
-function dol_sort_array(&$array, $index, $order='asc', $natsort, $case_sensitive)
+function dol_sort_array(&$array, $index, $order='asc', $natsort=0, $case_sensitive=0)
 {
     // Clean parameters
     $order=strtolower($order);
diff --git a/htdocs/societe/class/societe.class.php b/htdocs/societe/class/societe.class.php
index 565c43d1907..c71a286631c 100644
--- a/htdocs/societe/class/societe.class.php
+++ b/htdocs/societe/class/societe.class.php
@@ -47,15 +47,18 @@ class Societe extends CommonObject
     var $ismultientitymanaged = 1;	// 0=No test on entity, 1=Test with field entity, 2=Test with link by societe
 
     var $id;
+    var $name;     // TODO obsolete
     var $nom;
     var $nom_particulier;
     var $prenom;
     var $particulier;
     var $address;
-    var $adresse; // TODO obsolete
-    var $cp;
-    var $ville;
-    var $status; // 0=activity ceased, 1= in activity
+    var $adresse;  // TODO obsolete
+    var $cp;       // TODO obsolete
+    var $zip;
+    var $ville;    // TODO obsolete
+    var $town;
+    var $status;   // 0=activity ceased, 1= in activity
 
     var $state_id;
     var $state_code;
@@ -64,9 +67,9 @@ class Societe extends CommonObject
     var $departement_code;
     var $departement;
 
-    var $pays_id;
-    var $pays_code;
-    var $pays;	// TODO obsolete
+    var $pays_id;   // TODO obsolete
+    var $pays_code; // TODO obsolete
+    var $pays;	    // TODO obsolete
     var $country_id;
     var $country_code;
     var $country;
@@ -143,7 +146,8 @@ class Societe extends CommonObject
     var $logo_mini;
 
     /**
-     *    Constructor for class
+     *    Constructor
+     *
      *    @param  DB     handler acces base de donnees
      *    @param  id     id societe (0 par defaut)
      */
@@ -171,6 +175,7 @@ class Societe extends CommonObject
 
     /**
      *    Create third party in database
+     *
      *    @param      user        Object of user that ask creation
      *    @return     int         >= 0 if OK, < 0 if KO
      */
@@ -291,6 +296,7 @@ class Societe extends CommonObject
 
     /**
      *    Check properties of third party are ok (like name, third party codes, ...)
+     *
      *    @return     int		0 if OK, <0 if KO
      */
     function verify()
@@ -366,6 +372,7 @@ class Societe extends CommonObject
 
     /**
      *      Update parameters of third party
+     *
      *      @param      id              			id societe
      *      @param      user            			Utilisateur qui demande la mise a jour
      *      @param      call_trigger    			0=non, 1=oui
@@ -404,6 +411,7 @@ class Societe extends CommonObject
         $this->ville=$this->town;       // TODO obsolete
         $this->state_id=trim($this->state_id);
         $this->pays_id=trim($this->pays_id);
+        $this->country_id=trim($this->country_id);
         $this->tel=trim($this->tel);
         $this->fax=trim($this->fax);
         $this->tel = preg_replace("/\s/","",$this->tel);