Doc: Mise a jour doc doxygen

htdocs/comm/mailing/pre.inc.php

@@ -21,9 +21,8 @@
  *
  */
 
-/**     \file       htdocs/comm/mailling/pre.inc.php
+/**     \file       htdocs/comm/mailing/pre.inc.php
-        \ingroup    commercial
+        \brief      Fichier de gestion du menu gauche de l'espace mailing
-        \brief      Fichier de gestion du menu gauche de l'espace commercial mailing
         \version    $Revision$
 */
 

htdocs/compta/param/comptes/index.php

@@ -22,9 +22,9 @@
  */
 
 /*!
-        \file       htdocs/compta/index.php
+        \file       htdocs/compta/param/comptes/index.php
         \ingroup    compta
-		\brief      Page acceuil zone comptabilité
+		\brief      Page acceuil zone parametrages
 		\version    $Revision$
 */
 

htdocs/fichinter/fiche.php

@@ -20,7 +20,7 @@
  * $Source$
  */
 
-/** 	\file       htdocs/ficheinter.php
+/** 	\file       htdocs/fichinter/fiche.php
 		\brief      Fichier fiche intervention
 		\ingroup    ficheinter
 		\version    $Revision$

htdocs/includes/modules/DolibarrModules.class.php

@@ -222,7 +222,7 @@ class DolibarrModules
 
     /**     \brief      Fonction de désactivation. Supprime de la base les constantes et boites du module
      *      \param      array_sql       tableau de requete sql a exécuter à la désactivation
-     *      \reutnr     int             0 si erreur, 1 si ok
+     *      \return     int             0 si erreur, 1 si ok
      */
     function _remove($array_sql)
     {

htdocs/includes/modules/mailings/cerise.modules.php

@@ -36,7 +36,7 @@
  *
  */
 
-/**   	\file       htdocs/includes/modules/mailings/poire.modules.php
+/**   	\file       htdocs/includes/modules/mailings/cerise.modules.php
 		\ingroup    mailing
 		\brief      Fichier de la classe permettant de générer la liste de destinataires Cerise
 		\version    $Revision$

htdocs/lib/functions.inc.php

@@ -290,11 +290,10 @@ function dolibarr_print_object_info($object)
 }
 
 /**
-  \brief    Formatage du telephone
+  \brief    Formatage des numéros de telephone en fonction du format d'un pays
   \param	phone			Numéro de telephone à formater
-  \return   phone			Numéro de téléphone formaté
+  \param	country			Pays selon lequel formatter
-  \remarks  Ne tient pas en compte le format belge 02/211 34 83
+  \return   string			Numéro de téléphone formaté
-  \remarks  Formattage automatique des numero non formates
 */
 function dolibarr_print_phone($phone,$country="FR")
 {

htdocs/main.inc.php

@@ -212,7 +212,7 @@ function top_menu($head, $title="", $target="")
 
 /**
  *  \brief      Affiche barre de menu gauche
- *  \param      menu            Objet du menu gauche
+ *  \param      menu_array      Tableau des entrée de menu
  *  \param      help_url        Url pour le lien aide ('' par defaut)
  *  \param      form_search     Formulaire de recherche permanant supplémentaire
  */

htdocs/menu.class.php

@@ -57,7 +57,7 @@ class Menu {
      *  \brief      Ajoute une entrée de menu
      *  \param      url         Url a suivre sur le clic
      *  \param      titre       Libelle menu à afficher
-     *  \level      niveau      Niveau du menu à ajouter
+     *  \param      level       Niveau du menu à ajouter
      */
     function add($url, $titre, $level=0)
     {
@@ -71,7 +71,7 @@ class Menu {
      *  \brief      Ajoute une entrée de menu de niveau inférieur
      *  \param      url         Url a suivre sur le clic
      *  \param      titre       Libelle menu à afficher
-     *  \level      niveau      Niveau du menu à ajouter
+     *  \param      level       Niveau du menu à ajouter
      */
     function add_submenu($url, $titre, $level=1)
     {

htdocs/product.class.php

@@ -21,14 +21,16 @@
  *
  */
 
-/*!	\file       htdocs/product.class.php
+/**
+    	\file       htdocs/product.class.php
 		\ingroup    produit
 		\brief      Fichier de la classe des produits prédéfinis
 		\version    $Revision$
 */
 
 
-/*! \class Product
+/**
+        \class      Product
 		\brief      Classe permettant la gestion des produits prédéfinis
 */
 
@@ -238,9 +240,10 @@ class Product
 
   /**
    *    \brief  Modifie le prix d'achat pour un fournisseur
-   * \param fourn_id    id du fournisseur
+   *    \param  id_fourn        Id du fournisseur
-   * \param qty         quantite pour lequel le prix est valide
+   *    \param  qty             Quantite pour lequel le prix est valide
-   * \param buyprice       prix d'achat
+   *    \param  buyprice        Prix d'achat
+   *    \param  user            Objet user de l'utilisateur qui modifie
    *
    */
   function update_buyprice($id_fourn, $qty, $buyprice, $user) 

htdocs/translate.class.php

@@ -132,7 +132,7 @@ class Translate {
     /**
      *  \brief       Retourne la version traduite du texte passé en paramètre complété du code pays
      *  \param       str            chaine a traduire
-     *  \param       country_code   code pays (FR, ...)
+     *  \param       countrycode    code pays (FR, ...)
      *  \return      string         chaine traduite
      */
 

htdocs/user.class.php

@@ -592,6 +592,7 @@ class User
 
   /**
    *    \brief     Change le mot de passe d'un utilisateur et l'envoie par mail
+   *    \param     user            Object user de l'utilisateur qui fait la modification
    *    \param     password        Nouveau mot de passe (généré par defaut si non communiqué)
    *    \param     isencrypted     0 ou 1 si il faut crypter le mot de passe en base (0 par défaut)
    *    \return    int             <0 si erreur, 0 si changement ok mais envoi mail ko, 1 si ok