2
0
forked from Wavyzz/dolibarr

Doc: Mise a jour doc doxygen

This commit is contained in:
Laurent Destailleur
2005-03-01 21:44:32 +00:00
parent c795ce7c05
commit 8ffaf715e8
11 changed files with 25 additions and 23 deletions

View File

@@ -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$ \version $Revision$
*/ */

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -21,15 +21,17 @@
* *
*/ */
/*! \file htdocs/product.class.php /**
\file htdocs/product.class.php
\ingroup produit \ingroup produit
\brief Fichier de la classe des produits pr<70>d<EFBFBD>finis \brief Fichier de la classe des produits pr<70>d<EFBFBD>finis
\version $Revision$ \version $Revision$
*/ */
/*! \class Product /**
\brief Classe permettant la gestion des produits pr<70>d<EFBFBD>finis \class Product
\brief Classe permettant la gestion des produits pr<70>d<EFBFBD>finis
*/ */
class Product class Product
@@ -237,10 +239,11 @@ class Product
} }
/** /**
* \brief Modifie le prix d'achat pour un fournisseur * \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) function update_buyprice($id_fourn, $qty, $buyprice, $user)

View File

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

View File

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