From 8ffaf715e8d645243222cb4a2bc543f88644a9b4 Mon Sep 17 00:00:00 2001
From: Laurent Destailleur <eldy@users.sourceforge.net>
Date: Tue, 1 Mar 2005 21:44:32 +0000
Subject: [PATCH] Doc: Mise a jour doc doxygen
---
htdocs/comm/mailing/pre.inc.php | 5 ++---
htdocs/compta/param/comptes/index.php | 4 ++--
htdocs/fichinter/fiche.php | 2 +-
.../includes/modules/DolibarrModules.class.php | 2 +-
.../modules/mailings/cerise.modules.php | 2 +-
htdocs/lib/functions.inc.php | 7 +++----
htdocs/main.inc.php | 2 +-
htdocs/menu.class.php | 4 ++--
htdocs/product.class.php | 17 ++++++++++-------
htdocs/translate.class.php | 2 +-
htdocs/user.class.php | 1 +
11 files changed, 25 insertions(+), 23 deletions(-)
diff --git a/htdocs/comm/mailing/pre.inc.php b/htdocs/comm/mailing/pre.inc.php
index 8b7ac85cd89..f241a6fb273 100644
--- a/htdocs/comm/mailing/pre.inc.php
+++ b/htdocs/comm/mailing/pre.inc.php
@@ -21,9 +21,8 @@
*
*/
-/** \file htdocs/comm/mailling/pre.inc.php
- \ingroup commercial
- \brief Fichier de gestion du menu gauche de l'espace commercial mailing
+/** \file htdocs/comm/mailing/pre.inc.php
+ \brief Fichier de gestion du menu gauche de l'espace mailing
\version $Revision$
*/
diff --git a/htdocs/compta/param/comptes/index.php b/htdocs/compta/param/comptes/index.php
index 01ff73027b3..4fd0cf01a83 100644
--- a/htdocs/compta/param/comptes/index.php
+++ b/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$
*/
diff --git a/htdocs/fichinter/fiche.php b/htdocs/fichinter/fiche.php
index 5ee2a5bbd33..4b3bd8dbd64 100644
--- a/htdocs/fichinter/fiche.php
+++ b/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$
diff --git a/htdocs/includes/modules/DolibarrModules.class.php b/htdocs/includes/modules/DolibarrModules.class.php
index 5e677b01a06..8f3b29dbc94 100644
--- a/htdocs/includes/modules/DolibarrModules.class.php
+++ b/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)
{
diff --git a/htdocs/includes/modules/mailings/cerise.modules.php b/htdocs/includes/modules/mailings/cerise.modules.php
index 7d02862f012..5b636ca6b55 100644
--- a/htdocs/includes/modules/mailings/cerise.modules.php
+++ b/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$
diff --git a/htdocs/lib/functions.inc.php b/htdocs/lib/functions.inc.php
index 73c72d09875..d9144730617 100644
--- a/htdocs/lib/functions.inc.php
+++ b/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�
- \remarks Ne tient pas en compte le format belge 02/211 34 83
- \remarks Formattage automatique des numero non formates
+ \param country Pays selon lequel formatter
+ \return string Num�ro de t�l�phone format�
*/
function dolibarr_print_phone($phone,$country="FR")
{
diff --git a/htdocs/main.inc.php b/htdocs/main.inc.php
index 7fb997ef4c8..495f24a84cb 100644
--- a/htdocs/main.inc.php
+++ b/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
*/
diff --git a/htdocs/menu.class.php b/htdocs/menu.class.php
index 04f2f4ac18b..4364977e75e 100644
--- a/htdocs/menu.class.php
+++ b/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)
{
diff --git a/htdocs/product.class.php b/htdocs/product.class.php
index e95a6be7773..bffee53791b 100644
--- a/htdocs/product.class.php
+++ b/htdocs/product.class.php
@@ -21,15 +21,17 @@
*
*/
-/*! \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
- \brief Classe permettant la gestion des produits pr�d�finis
+/**
+ \class Product
+ \brief Classe permettant la gestion des produits pr�d�finis
*/
class Product
@@ -237,10 +239,11 @@ class Product
}
/**
- * \brief Modifie le prix d'achat pour un fournisseur
- * \param fourn_id id du fournisseur
- * \param qty quantite pour lequel le prix est valide
- * \param buyprice prix d'achat
+ * \brief Modifie le prix d'achat pour un fournisseur
+ * \param id_fourn Id du fournisseur
+ * \param qty Quantite pour lequel le prix est valide
+ * \param buyprice Prix d'achat
+ * \param user Objet user de l'utilisateur qui modifie
*
*/
function update_buyprice($id_fourn, $qty, $buyprice, $user)
diff --git a/htdocs/translate.class.php b/htdocs/translate.class.php
index a5a6975a1e6..d4c179a6e1a 100644
--- a/htdocs/translate.class.php
+++ b/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
*/
diff --git a/htdocs/user.class.php b/htdocs/user.class.php
index 50220f0b9d5..5032d9b81fd 100644
--- a/htdocs/user.class.php
+++ b/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
--
GitLab