From c361512ea768939e79fad54f49bbcc71896e1a69 Mon Sep 17 00:00:00 2001
From: Laurent Destailleur <eldy@users.sourceforge.net>
Date: Wed, 24 Aug 2005 16:37:10 +0000
Subject: [PATCH] Doc: Documentation doxygen

---
 htdocs/boutique/client/client.class.php | 79 +++++++++++++------------
 htdocs/boutique/client/pre.inc.php      | 15 ++++-
 htdocs/dossier/client/fiche.php         |  8 ++-
 3 files changed, 61 insertions(+), 41 deletions(-)

diff --git a/htdocs/boutique/client/client.class.php b/htdocs/boutique/client/client.class.php
index 3de0647e0df..17b3becce78 100644
--- a/htdocs/boutique/client/client.class.php
+++ b/htdocs/boutique/client/client.class.php
@@ -20,54 +20,59 @@
  *
  */
 
-/*!	\file htdocs/boutique/client/client.class.php
-		\brief Classe permettant de gèrer des clients de la boutique online
-		\author	Rodolphe Quiedeville
-		\version $Revision$
+/**
+        \file       htdocs/boutique/client/client.class.php
+		\brief      Classe permettant de gèrer des clients de la boutique online
+		\author	    Rodolphe Quiedeville
+		\version    $Revision$
 */
 
-/*! \class Client
-		\brief Classe permettant de gèrer des clients de la boutique online
+/** 
+        \class      Client
+		\brief      Classe permettant de gèrer des clients de la boutique online
 */
 
-class Client {
-  var $db ;
+class Client
+{
+    var $db ;
 
-  var $id ;
-  var $nom;
+    var $id ;
+    var $nom;
 
-  function Client($DB, $id=0) {
-    $this->db = $DB;
-    $this->id = $id ;
-  }
+    function Client($DB, $id=0)
+    {
+        $this->db = $DB;
+        $this->id = $id ;
+    }
 
-/*!
-		\brief fonction permettant de recupèrer les informations d'un clients de la boutique
-		\param id				id du client
-*/
+    /**
+            \brief  Fonction permettant de recupèrer les informations d'un clients de la boutique
+            \param  Id				id du client
+    */
 
-  function fetch ($id) {
-    
-    $sql = "SELECT customers_id, customers_lastname, customers_firstname FROM ".OSC_DB_NAME.".customers WHERE customers_id = $id";
+    function fetch ($id)
+    {
 
-    $result = $this->db->query($sql) ;
+        $sql = "SELECT customers_id, customers_lastname, customers_firstname FROM ".OSC_DB_NAME.".customers WHERE customers_id = $id";
 
-    if ( $result )
-      {
-	$result = $this->db->fetch_array();
+        $result = $this->db->query($sql) ;
 
-	$this->id      = $result["customers_id"];
-	$this->name    = stripslashes($result["customers_firstname"]) . " " . stripslashes($result["customers_lastname"]);
-	
-	$this->db->free();
-      }
-    else
-      {
-	print $this->db->error();
-      }
-    
-    return $result;
-  }
+        if ( $result )
+        {
+            $result = $this->db->fetch_array();
+
+            $this->id      = $result["customers_id"];
+            $this->name    = stripslashes($result["customers_firstname"]) . " " . stripslashes($result["customers_lastname"]);
+
+            $this->db->free();
+        }
+        else
+        {
+            print $this->db->error();
+        }
+
+        return $result;
+    }
 
 }
 ?>
diff --git a/htdocs/boutique/client/pre.inc.php b/htdocs/boutique/client/pre.inc.php
index ce6218ad535..ae4d8090f69 100644
--- a/htdocs/boutique/client/pre.inc.php
+++ b/htdocs/boutique/client/pre.inc.php
@@ -19,10 +19,19 @@
  * $Source$
  *
  */
-require("../../main.inc.php");
-require("./client.class.php");
 
-function llxHeader($head = "", $urlp = "") {
+/**
+        \file       htdocs/boutique/client/pre.inc.php
+		\brief      Fichier gestionnaire du menu de gauche de l'espace boutique client
+		\version    $Revision$
+*/
+
+require("../../main.inc.php");
+require_once(DOL_DOCUMENT_ROOT.'/client.class.php');
+
+
+function llxHeader($head = "", $urlp = "")
+{
   global $user, $conf;
 
   /*
diff --git a/htdocs/dossier/client/fiche.php b/htdocs/dossier/client/fiche.php
index c98d75e8b1e..6fa4c7d366c 100644
--- a/htdocs/dossier/client/fiche.php
+++ b/htdocs/dossier/client/fiche.php
@@ -21,8 +21,14 @@
  *
  */
 
+/**
+        \file       htdocs/dossier/client/fiche.php
+        \brief      Page des dossiers clients
+        \version    $Revision$
+*/
+
 require("./pre.inc.php");
-require_once DOL_DOCUMENT_ROOT.'/client.class.php';
+require_once(DOL_DOCUMENT_ROOT.'/client.class.php');
 
 $user->getrights("facture");