From 05679cb4def9dd51f348cd329b91fdac1bde0da8 Mon Sep 17 00:00:00 2001
From: Laurent Destailleur <eldy@users.sourceforge.net>
Date: Mon, 4 Jul 2011 11:41:02 +0000
Subject: [PATCH] Doxygen

---
 htdocs/societe/class/societe.class.php | 13 +++++++---
 htdocs/user/class/user.class.php       | 12 +++++++---
 htdocs/user/class/usergroup.class.php  | 33 +++++++++++++-------------
 3 files changed, 35 insertions(+), 23 deletions(-)

diff --git a/htdocs/societe/class/societe.class.php b/htdocs/societe/class/societe.class.php
index 4f9c6550c32..7caf9a3e478 100644
--- a/htdocs/societe/class/societe.class.php
+++ b/htdocs/societe/class/societe.class.php
@@ -27,7 +27,7 @@
  *	\file       htdocs/societe/class/societe.class.php
  *	\ingroup    societe
  *	\brief      File for third party class
- *	\version    $Id: societe.class.php,v 1.88 2011/07/03 22:07:24 eldy Exp $
+ *	\version    $Id: societe.class.php,v 1.89 2011/07/04 11:41:05 eldy Exp $
  */
 require_once(DOL_DOCUMENT_ROOT."/core/class/commonobject.class.php");
 
@@ -2105,6 +2105,13 @@ class Societe extends CommonObject
     }
 
 
+    /**
+     * Add permissions
+     * @param   user_id
+     * @param   read
+     * @param   write
+     * @param   perms
+     */
     function AddPerms($user_id, $read, $write, $perms)
     {
         $sql = "INSERT INTO ".MAIN_DB_PREFIX."societe_perms";
@@ -2120,7 +2127,7 @@ class Societe extends CommonObject
 
     /**
      *       Charge les informations d'ordre info dans l'objet societe
-     *       @param     id     id de la societe a charger
+     *       @param     id     Id de la societe a charger
      */
     function info($id)
     {
@@ -2183,7 +2190,7 @@ class Societe extends CommonObject
 
     /**
      *       Return if a country is inside the EEC (European Economic Community)
-     *       @param     boolean		true = pays inside EEC, false= pays outside EEC
+     *       @return     boolean		true = pays inside EEC, false= pays outside EEC
      */
     function isInEEC()
     {
diff --git a/htdocs/user/class/user.class.php b/htdocs/user/class/user.class.php
index 3425b0fe346..97901def506 100644
--- a/htdocs/user/class/user.class.php
+++ b/htdocs/user/class/user.class.php
@@ -25,7 +25,7 @@
 /**
  *  \file       htdocs/user/class/user.class.php
  *  \brief      Fichier de la classe utilisateur
- *  \version    $Id: user.class.php,v 1.43 2011/06/29 10:23:32 eldy Exp $
+ *  \version    $Id: user.class.php,v 1.44 2011/07/04 11:41:02 eldy Exp $
  */
 
 require_once(DOL_DOCUMENT_ROOT ."/core/class/commonobject.class.php");
@@ -1482,7 +1482,10 @@ class User extends CommonObject
 
 	/**
 	 *    Add user into a group
-	 *    @param       group       id du groupe
+	 *    @param       group       Id of group
+	 *    @param       entity      Entity
+	 *    @param       notrigger   Disable triggers
+	 *    @return      int         <0 if KO, >0 if OK
 	 */
 	function SetInGroup($group, $entity, $notrigger=0)
 	{
@@ -1539,7 +1542,10 @@ class User extends CommonObject
 
 	/**
 	 *    Remove a user from a group
-	 *    @param      group       id du groupe
+     *    @param       group       Id of group
+     *    @param       entity      Entity
+     *    @param       notrigger   Disable triggers
+     *    @return      int         <0 if KO, >0 if OK
 	 */
 	function RemoveFromGroup($group, $entity, $notrigger=0)
 	{
diff --git a/htdocs/user/class/usergroup.class.php b/htdocs/user/class/usergroup.class.php
index 3bb668d7e55..51ba9f3efab 100644
--- a/htdocs/user/class/usergroup.class.php
+++ b/htdocs/user/class/usergroup.class.php
@@ -22,7 +22,7 @@
  *	 \file       htdocs/user/class/usergroup.class.php
  *	 \brief      Fichier de la classe des groupes d'utilisateur
  *	 \author     Rodolphe Qiedeville
- *	 \version    $Id$
+ *	 \version    $Id: usergroup.class.php,v 1.10 2011/07/04 11:41:04 eldy Exp $
  */
 
 require_once(DOL_DOCUMENT_ROOT."/core/class/commonobject.class.php");
@@ -55,9 +55,8 @@ class UserGroup extends CommonObject
 
 
 	/**
-	 *    \brief Constructeur de la classe
-	 *    \param  DB         Handler acces base de donnees
-	 *    \param  id         Id du groupe (0 par defaut)
+	 *    Constructor
+	 *    @param  DB         Handler acces base de donnees
 	 */
 	function UserGroup($DB)
 	{
@@ -68,9 +67,9 @@ class UserGroup extends CommonObject
 
 
 	/**
-	 *	\brief      Charge un objet group avec toutes ces caracteristiques (excpet ->members array)
-	 *	\param      id      id du groupe a charger
-	 *	\return		int		<0 si KO, >0 si OK
+	 *	Charge un objet group avec toutes ces caracteristiques (excpet ->members array)
+	 *	@param      id      id du groupe a charger
+	 *	@return		int		<0 si KO, >0 si OK
 	 */
 	function fetch($id)
 	{
@@ -117,13 +116,13 @@ class UserGroup extends CommonObject
 
 	/**
 	 * 	Return array of groups objects for a particular user
-	 *	@param		usertosearch
-	 * 	@return		array of groups objects
+	 *	@param		userid    User id to search
+	 * 	@return		array     Array of groups objects
 	 */
 	function listGroupsForUser($userid)
 	{
 		global $conf;
-		
+
 		$ret=array();
 
 		$sql = "SELECT g.rowid, ug.entity as usergroup_entity";
@@ -143,12 +142,12 @@ class UserGroup extends CommonObject
 				$group=new UserGroup($this->db);
 				$group->fetch($obj->rowid);
 				$group->usergroup_entity = $obj->usergroup_entity;
-				
+
 				$ret[]=$group;
 			}
-			
+
 			$this->db->free($result);
-			
+
 			return $ret;
 		}
 		else
@@ -166,7 +165,7 @@ class UserGroup extends CommonObject
 	function listUsersForGroup()
 	{
 		global $conf;
-		
+
 		$ret=array();
 
 		$sql = "SELECT u.rowid, ug.entity as usergroup_entity";
@@ -188,9 +187,9 @@ class UserGroup extends CommonObject
 
 				$ret[]=$user;
 			}
-			
+
 			$this->db->free($result);
-			
+
 			return $ret;
 		}
 		else
@@ -524,7 +523,7 @@ class UserGroup extends CommonObject
 			$this->id = $this->db->last_insert_id(MAIN_DB_PREFIX."usergroup");
 
 			if ($this->update(1) < 0) return -2;
-			
+
 			if (! $notrigger)
 			{
 				// Appel des triggers