Doc: Documentation doxygen

htdocs/compta/export/modules/compta.export.class.php

@@ -19,29 +19,28 @@
  * $Source$
  */
 
-/*!
-  \file       htdocs/compta/export/modules/compta.export.class.php
-  \ingroup    compta
-  \brief      Fichier de la classe d'export compta
-  \version    $Revision$
+/**
+        \file       htdocs/compta/export/modules/compta.export.class.php
+        \ingroup    compta
+        \brief      Fichier de la classe d'export compta
+        \version    $Revision$
 */
 
 
-/*!
-  \class      ComptaExport
-  \brief      Classe permettant les exports comptables
+/**
+        \class      ComptaExport
+        \brief      Classe permettant les exports comptables
 */
 
 class ComptaExport
 {
 
-  /*!
-    \brief      Createur Classe
-    \param      DB       object de base de données
-    \param      USER     object utilisateur    
-    \param      class    nom de la classe utilisée pour formater les rapports
+  /**
+        \brief      Constructeur de la class
+        \param      DB          Object de base de données
+        \param      USER        Object utilisateur    
+        \param      classe      Nom de la classe utilisée pour formater les rapports
   */
-
   function ComptaExport ($DB, $USER, $classe)
   {
     $this->db = $DB;
@@ -50,10 +49,11 @@ class ComptaExport
     $this->error_message = '';
   }
 
-  /*!
-    \brief      Lecture des factures dans la base
-  */
 
+  /**
+        \brief      Lecture des factures dans la base
+        \param      id      Id ligne
+  */
   function ReadLines($id=0)
   {
     dolibarr_syslog("ComptaExport::ReadLines id=".$id);
@@ -123,8 +123,9 @@ class ComptaExport
     return $error;
   }
 
-  /*!
-    \brief      Lecture des paiements dans la base
+  /**
+        \brief      Lecture des paiements dans la base
+        \param      id      Id ligne
   */
 
   function ReadLinesPayment($id=0)
@@ -196,7 +197,7 @@ class ComptaExport
     return $error;
   }
 
-  /*!
+  /**
     \brief      Créé le fichier d'export
   */
 

htdocs/html.form.class.php

@@ -532,7 +532,7 @@ class Form
    *    \param      selected        Type de praiement présélectionné
    *    \param      htmlname        Nom de la zone select
    *    \param      statut          Statut des comptes recherchés
-   *    \param      filtretype      Pour filtre
+   *    \param      filtre          Pour filtre sur la liste
    */
     function select_comptes($selected='',$htmlname='paiementtype',$statut=0,$filtre='')
     {

htdocs/lib/functions.inc.php

@@ -492,7 +492,7 @@ function img_action($alt = "default", $numaction)
 /**
         \brief      Affiche logo statut
         \param      num         Numéro statut
-        \param      text        Texte a afficher sur alt
+        \param      alt         Texte a afficher sur alt
         \return     string      Retourne tag img
 */
 function img_statut($num,$alt = "default")

htdocs/lib/mysql.lib.php

@@ -76,11 +76,12 @@ class DoliDb
 
     /**
             \brief      Ouverture d'une connection vers le serveur et éventuellement une database.
-            \param      type		type de base de données (mysql ou pgsql)
-            \param	    host		addresse de la base de données
-    	\param	    user		nom de l'utilisateur autorisé
-            \param	    pass		mot de passe
-            \param	    name		nom de la database
+            \param      type		Type de base de données (mysql ou pgsql)
+            \param	    host		Addresse de la base de données
+    	    \param	    user		Nom de l'utilisateur autorisé
+            \param	    pass		Mot de passe
+            \param	    name		Nom de la database
+            \param	    newlink     ???
             \return     int			1 en cas de succès, 0 sinon
     */
     function DoliDb($type='mysql', $host, $user, $pass, $name='', $newlink=0)