From 6e3aeee8c7132b4221d890690b8a52b2acab939b Mon Sep 17 00:00:00 2001
From: Laurent Destailleur <eldy@users.sourceforge.net>
Date: Sun, 20 Jan 2008 19:24:05 +0000
Subject: [PATCH] Doc: Maj doc doxygen
---
htdocs/admin/editeur.php | 2 +-
htdocs/admin/import/index.php | 2 +-
htdocs/boutique/critiques/index.php | 2 +-
htdocs/boutique/promotion/index.php | 2 +-
htdocs/compta/paiement/cheque/remisecheque.class.php | 11 +++++------
htdocs/docs/document.class.php | 2 +-
.../includes/menus/barre_left/auguria_backoffice.php | 1 -
.../includes/menus/barre_left/auguria_frontoffice.php | 3 +--
htdocs/includes/menus/barre_left/rodolphe.php | 4 +---
.../includes/menus/barre_top/auguria_backoffice.php | 2 +-
.../includes/menus/barre_top/auguria_frontoffice.php | 2 +-
htdocs/includes/menus/barre_top/rodolphe.php | 2 +-
htdocs/includes/modules/facture/pdf_crabe.modules.php | 5 +++--
.../includes/modules/facture/pdf_huitre.modules.php | 5 +++--
.../includes/modules/facture/pdf_oursin.modules.php | 5 +++--
htdocs/includes/modules/modAgenda.class.php | 4 ++--
.../modules/propale/pdf_propale_azur.modules.php | 5 +++--
.../modules/propale/pdf_propale_bleu.modules.php | 6 +++---
.../modules/propale/pdf_propale_jaune.modules.php | 6 +++---
.../modules/propale/pdf_propale_rouge.modules.php | 6 +++---
.../modules/propale/pdf_propale_vert.modules.php | 6 +++---
htdocs/includes/vcard/vcard.class.php | 10 +++++-----
htdocs/lib/databases/mssql.lib.php | 2 +-
htdocs/lib/databases/mysql.lib.php | 2 +-
htdocs/lib/databases/mysqli.lib.php | 2 +-
htdocs/lib/databases/pgsql.lib.php | 2 +-
htdocs/propal.class.php | 11 +++++------
htdocs/translate.class.php | 5 +++--
htdocs/user.class.php | 2 +-
htdocs/webcal/webcal.class.php | 2 +-
30 files changed, 60 insertions(+), 61 deletions(-)
diff --git a/htdocs/admin/editeur.php b/htdocs/admin/editeur.php
index ae1ada7b125..24810045373 100644
--- a/htdocs/admin/editeur.php
+++ b/htdocs/admin/editeur.php
@@ -20,7 +20,7 @@
*/
/**
- \file htdocs/admin/adherent.php
+ \file htdocs/admin/editeur.php
\ingroup editeur
\brief Page d'administration/configuration du module Editeur
\version $Revision$
diff --git a/htdocs/admin/import/index.php b/htdocs/admin/import/index.php
index ed1d6aba147..aa5c8c25303 100644
--- a/htdocs/admin/import/index.php
+++ b/htdocs/admin/import/index.php
@@ -20,7 +20,7 @@
*/
/**
- \file htdocs/imports/index.php
+ \file htdocs/admin/imports/index.php
\ingroup core
\brief Page accueil de la zone import
\version $Revision$
diff --git a/htdocs/boutique/critiques/index.php b/htdocs/boutique/critiques/index.php
index 0c32a78d4aa..89c64584a9a 100644
--- a/htdocs/boutique/critiques/index.php
+++ b/htdocs/boutique/critiques/index.php
@@ -21,7 +21,7 @@
*/
/**
- \file htdocs/boutique/critiques/fiche.php
+ \file htdocs/boutique/critiques/index.php
\ingroup boutique
\brief Page gestion critiques OSCommerce
\version $Revision$
diff --git a/htdocs/boutique/promotion/index.php b/htdocs/boutique/promotion/index.php
index 94a5314afad..f09372d68f0 100644
--- a/htdocs/boutique/promotion/index.php
+++ b/htdocs/boutique/promotion/index.php
@@ -21,7 +21,7 @@
*/
/**
- \file htdocs/boutique/promotions/fiche.php
+ \file htdocs/boutique/promotions/index.php
\ingroup boutique
\brief Page gestion promotions OSCommerce
\version $Revision$
diff --git a/htdocs/compta/paiement/cheque/remisecheque.class.php b/htdocs/compta/paiement/cheque/remisecheque.class.php
index b80fad5f014..c4dc97af4ab 100644
--- a/htdocs/compta/paiement/cheque/remisecheque.class.php
+++ b/htdocs/compta/paiement/cheque/remisecheque.class.php
@@ -20,7 +20,7 @@
*/
/**
- \file htdocs/compta/paiement/cheque/resimecheque.class.php
+ \file htdocs/compta/paiement/cheque/remisecheque.class.php
\ingroup compta
\brief Fichier de la classe des bordereau de remise de cheque
\version $Revision$
@@ -230,9 +230,8 @@ class RemiseCheque extends CommonObject
/**
\brief Supprime la remise en base
\param user utilisateur qui effectue l'operation
- \param account_id Compte bancaire concerne
*/
- function Delete()
+ function Delete($user='')
{
$this->errno = 0;
$this->db->begin();
@@ -277,10 +276,10 @@ class RemiseCheque extends CommonObject
return $this->errno;
}
+
/**
\brief Supprime la remise en base
- \param user utilisateur qui effectue l'operation
- \param account_id Compte bancaire concerne
+ \param user Utilisateur qui effectue l'operation
*/
function Validate($user)
{
@@ -389,7 +388,7 @@ class RemiseCheque extends CommonObject
\brief G�n�re le fichier PDF
\param model Nom du modele
\return int <0 si KO, 0 si OK
- \todo Finir la gestion multi mod�le
+ \TODO Finir la gestion multi mod�le
*/
function GeneratePdf($model='Blochet')
{
diff --git a/htdocs/docs/document.class.php b/htdocs/docs/document.class.php
index 7a7ebb1f828..e2103352af2 100644
--- a/htdocs/docs/document.class.php
+++ b/htdocs/docs/document.class.php
@@ -21,7 +21,7 @@
*/
/**
- \file docs/class/courrier-droit-editeur.class.php
+ \file htdocs/docs/document.class.php
\ingroup editeurs
\brief Classe de generation des courriers pour les editeurs
*/
diff --git a/htdocs/includes/menus/barre_left/auguria_backoffice.php b/htdocs/includes/menus/barre_left/auguria_backoffice.php
index c44446b07e0..0b787ff0640 100644
--- a/htdocs/includes/menus/barre_left/auguria_backoffice.php
+++ b/htdocs/includes/menus/barre_left/auguria_backoffice.php
@@ -16,7 +16,6 @@
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
* $Id$
- * $Source$
*/
/**
diff --git a/htdocs/includes/menus/barre_left/auguria_frontoffice.php b/htdocs/includes/menus/barre_left/auguria_frontoffice.php
index 1396a6fefb5..68ec3a39bf9 100644
--- a/htdocs/includes/menus/barre_left/auguria_frontoffice.php
+++ b/htdocs/includes/menus/barre_left/auguria_frontoffice.php
@@ -16,11 +16,10 @@
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
* $Id$
- * $Source$
*/
/**
- \file htdocs/includes/menus/barre_left/auguria_backoffice.php
+ \file htdocs/includes/menus/barre_left/auguria_frontoffice.php
\brief Gestionnaire du menu du gauche Auguria
\version $Revision$
diff --git a/htdocs/includes/menus/barre_left/rodolphe.php b/htdocs/includes/menus/barre_left/rodolphe.php
index 91d7591ae28..e430dba69d5 100644
--- a/htdocs/includes/menus/barre_left/rodolphe.php
+++ b/htdocs/includes/menus/barre_left/rodolphe.php
@@ -16,11 +16,9 @@
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
* $Id$
- * $Source$
- *
*/
-/** \file htdocs/includes/menus/barre_left/default.php
+/** \file htdocs/includes/menus/barre_left/rodolphe.php
\brief Gestionnaire par d�faut du menu de gauche
\version $Revision$
diff --git a/htdocs/includes/menus/barre_top/auguria_backoffice.php b/htdocs/includes/menus/barre_top/auguria_backoffice.php
index 8de5f74e56b..5864cec503f 100644
--- a/htdocs/includes/menus/barre_top/auguria_backoffice.php
+++ b/htdocs/includes/menus/barre_top/auguria_backoffice.php
@@ -20,7 +20,7 @@
/**
\file htdocs/includes/menus/barre_top/auguria_backoffice.php
- \brief Gestionnaire nomm� Auguria du menu du haut
+ \brief Gestionnaire nomme Auguria du menu du haut
\version $Revision$
\remarks La construction d'un gestionnaire pour le menu du haut est simple:
diff --git a/htdocs/includes/menus/barre_top/auguria_frontoffice.php b/htdocs/includes/menus/barre_top/auguria_frontoffice.php
index c498539b44b..b4e0d66a709 100644
--- a/htdocs/includes/menus/barre_top/auguria_frontoffice.php
+++ b/htdocs/includes/menus/barre_top/auguria_frontoffice.php
@@ -20,7 +20,7 @@
/**
\file htdocs/includes/menus/barre_top/auguria_backoffice.php
- \brief Gestionnaire nomm� Auguria du menu du haut
+ \brief Gestionnaire nomme Auguria du menu du haut
\version $Revision$
\remarks La construction d'un gestionnaire pour le menu du haut est simple:
diff --git a/htdocs/includes/menus/barre_top/rodolphe.php b/htdocs/includes/menus/barre_top/rodolphe.php
index 8f9f619fbca..6e1cc350925 100644
--- a/htdocs/includes/menus/barre_top/rodolphe.php
+++ b/htdocs/includes/menus/barre_top/rodolphe.php
@@ -20,7 +20,7 @@
*/
/**
- \file htdocs/includes/menus/barre_top/default.php
+ \file htdocs/includes/menus/barre_top/rodolphe.php
\brief Gestionnaire par d�faut du menu du haut
\remarks La construction d'un gestionnaire pour le menu du haut est simple:
diff --git a/htdocs/includes/modules/facture/pdf_crabe.modules.php b/htdocs/includes/modules/facture/pdf_crabe.modules.php
index fc81dc39872..f207af61f52 100644
--- a/htdocs/includes/modules/facture/pdf_crabe.modules.php
+++ b/htdocs/includes/modules/facture/pdf_crabe.modules.php
@@ -100,8 +100,9 @@ class pdf_crabe extends ModelePDFFactures
/**
* \brief Fonction générant la facture sur le disque
- * \param fac Objet facture à générer (ou id si ancienne methode)
- * \return int 1=ok, 0=ko
+ * \param fac Objet facture à générer (ou id si ancienne methode)
+ * \param outputlangs Lang object for output language
+ * \return int 1=ok, 0=ko
*/
function write_file($fac,$outputlangs='')
{
diff --git a/htdocs/includes/modules/facture/pdf_huitre.modules.php b/htdocs/includes/modules/facture/pdf_huitre.modules.php
index cc7f2370a8b..5cecc4af6c2 100644
--- a/htdocs/includes/modules/facture/pdf_huitre.modules.php
+++ b/htdocs/includes/modules/facture/pdf_huitre.modules.php
@@ -80,8 +80,9 @@ class pdf_huitre extends ModelePDFFactures
/**
* \brief Fonction g�n�rant la facture sur le disque
- * \param fac Objet facture � g�n�rer (ou id si ancienne methode)
- * \return int 1=ok, 0=ko
+ * \param fac Objet facture � g�n�rer (ou id si ancienne methode)
+ * \param outputlangs Lang object for output language
+ * \return int 1=ok, 0=ko
*/
function write_file($fac,$outputlangs='')
{
diff --git a/htdocs/includes/modules/facture/pdf_oursin.modules.php b/htdocs/includes/modules/facture/pdf_oursin.modules.php
index 8d294667c9f..0fc08b934d2 100644
--- a/htdocs/includes/modules/facture/pdf_oursin.modules.php
+++ b/htdocs/includes/modules/facture/pdf_oursin.modules.php
@@ -84,8 +84,9 @@ class pdf_oursin extends ModelePDFFactures
/**
* \brief Fonction g�n�rant la facture sur le disque
- * \param fac Objet facture � g�n�rer (ou id si ancienne methode)
- * \return int 1=ok, 0=ko
+ * \param fac Objet facture � g�n�rer (ou id si ancienne methode)
+ * \param outputlangs Lang object for output language
+ * \return int 1=ok, 0=ko
*/
function write_file($fac,$outputlangs='')
{
diff --git a/htdocs/includes/modules/modAgenda.class.php b/htdocs/includes/modules/modAgenda.class.php
index 485a0151f31..b210c733f18 100644
--- a/htdocs/includes/modules/modAgenda.class.php
+++ b/htdocs/includes/modules/modAgenda.class.php
@@ -23,8 +23,8 @@
*/
/**
- \defgroup adherent Module adherents
- \brief Module pour gerer les adherents d'une association
+ \defgroup agenda Module agenda
+ \brief Module pour gerer l'agenda et actions
*/
/**
diff --git a/htdocs/includes/modules/propale/pdf_propale_azur.modules.php b/htdocs/includes/modules/propale/pdf_propale_azur.modules.php
index 3745c991b0c..f81f30d8e76 100644
--- a/htdocs/includes/modules/propale/pdf_propale_azur.modules.php
+++ b/htdocs/includes/modules/propale/pdf_propale_azur.modules.php
@@ -99,8 +99,9 @@ class pdf_propale_azur extends ModelePDFPropales
/**
\brief Fonction g�n�rant la propale sur le disque
- \param propale Objet propal � g�n�rer (ou id si ancienne methode)
- \return int 1=ok, 0=ko
+ \param propale Objet propal � g�n�rer (ou id si ancienne methode)
+ \param outputlangs Lang object for output language
+ \return int 1=ok, 0=ko
*/
function write_file($propale,$outputlangs='')
{
diff --git a/htdocs/includes/modules/propale/pdf_propale_bleu.modules.php b/htdocs/includes/modules/propale/pdf_propale_bleu.modules.php
index 2e9cb81026a..609bcd1216a 100644
--- a/htdocs/includes/modules/propale/pdf_propale_bleu.modules.php
+++ b/htdocs/includes/modules/propale/pdf_propale_bleu.modules.php
@@ -18,7 +18,6 @@
* or see http://www.gnu.org/
*
* $Id$
- * $Source$
*/
/** \file htdocs/includes/modules/propale/pdf_propale_bleu.modules.php
@@ -74,8 +73,9 @@ class pdf_propale_bleu extends ModelePDFPropales
/**
\brief Fonction g�n�rant la propale sur le disque
- \param propale Objet propal
- \return int 1=ok, 0=ko
+ \param propale Objet propal
+ \param outputlangs Lang object for output language
+ \return int 1=ok, 0=ko
*/
function write_file($propale,$outputlangs='')
{
diff --git a/htdocs/includes/modules/propale/pdf_propale_jaune.modules.php b/htdocs/includes/modules/propale/pdf_propale_jaune.modules.php
index c237cede86a..e50f9480600 100644
--- a/htdocs/includes/modules/propale/pdf_propale_jaune.modules.php
+++ b/htdocs/includes/modules/propale/pdf_propale_jaune.modules.php
@@ -18,7 +18,6 @@
* or see http://www.gnu.org/
*
* $Id$
- * $Source$
*/
/** \file htdocs/includes/modules/propale/pdf_propale_jaune.modules.php
@@ -75,8 +74,9 @@ class pdf_propale_jaune extends ModelePDFPropales
/**
\brief Fonction g�n�rant la propale sur le disque
- \param propale Objet propal
- \return int 1=ok, 0=ko
+ \param propale Objet propal
+ \param outputlangs Lang object for output language
+ \return int 1=ok, 0=ko
*/
function write_file($propale,$outputlangs='')
{
diff --git a/htdocs/includes/modules/propale/pdf_propale_rouge.modules.php b/htdocs/includes/modules/propale/pdf_propale_rouge.modules.php
index 20b383d600b..c9e81a960a1 100644
--- a/htdocs/includes/modules/propale/pdf_propale_rouge.modules.php
+++ b/htdocs/includes/modules/propale/pdf_propale_rouge.modules.php
@@ -18,7 +18,6 @@
* or see http://www.gnu.org/
*
* $Id$
- * $Source$
*/
/**
@@ -78,8 +77,9 @@ class pdf_propale_rouge extends ModelePDFPropales
/**
\brief Fonction g�n�rant la propale sur le disque
- \param propale Objet propal
- \return int 1=ok, 0=ko
+ \param propale Objet propal
+ \param outputlangs Lang object for output language
+ \return int 1=ok, 0=ko
*/
function write_file($propale,$outputlangs='')
{
diff --git a/htdocs/includes/modules/propale/pdf_propale_vert.modules.php b/htdocs/includes/modules/propale/pdf_propale_vert.modules.php
index 98b01dce9dc..496a76a1510 100644
--- a/htdocs/includes/modules/propale/pdf_propale_vert.modules.php
+++ b/htdocs/includes/modules/propale/pdf_propale_vert.modules.php
@@ -19,7 +19,6 @@
* or see http://www.gnu.org/
*
* $Id$
- * $Source$
*/
/** \file htdocs/includes/modules/propale/pdf_propale_vert.modules.php
@@ -76,8 +75,9 @@ class pdf_propale_vert extends ModelePDFPropales
/**
\brief Fonction g�n�rant la propale sur le disque
- \param propale Objet propal
- \return int 1=ok, 0=ko
+ \param propale Objet propal
+ \param outputlangs Lang object for output language
+ \return int 1=ok, 0=ko
*/
function write_file($propale,$outputlangs='')
{
diff --git a/htdocs/includes/vcard/vcard.class.php b/htdocs/includes/vcard/vcard.class.php
index a0ebe57876c..f08000ba31b 100644
--- a/htdocs/includes/vcard/vcard.class.php
+++ b/htdocs/includes/vcard/vcard.class.php
@@ -197,11 +197,11 @@ class vCard {
$this->properties["LABEL;$type;ENCODING=QUOTED-PRINTABLE"] = quoted_printable_encode($label);
}
-/**
- \brief mise en forme de l'email
- \param address
-*/
-
+ /**
+ \brief Mise en forme de l'email
+ \param address EMail
+ \param type Vcard type
+ */
function setEmail($address,$type="internet,pref") {
$this->properties["EMAIL;TYPE=".$type] = $address;
}
diff --git a/htdocs/lib/databases/mssql.lib.php b/htdocs/lib/databases/mssql.lib.php
index c1904444cb4..c502f8fb556 100644
--- a/htdocs/lib/databases/mssql.lib.php
+++ b/htdocs/lib/databases/mssql.lib.php
@@ -22,7 +22,7 @@
*/
/**
- \file htdocs/lib/mssql.lib.php
+ \file htdocs/lib/databases/mssql.lib.php
\brief Fichier de la classe permettant de g�rer une base mssql
*/
diff --git a/htdocs/lib/databases/mysql.lib.php b/htdocs/lib/databases/mysql.lib.php
index f7df54f9597..c54d17090a8 100644
--- a/htdocs/lib/databases/mysql.lib.php
+++ b/htdocs/lib/databases/mysql.lib.php
@@ -23,7 +23,7 @@
*/
/**
- \file htdocs/lib/mysql.lib.php
+ \file htdocs/lib/databases/mysql.lib.php
\brief Fichier de la classe permettant de g�rer une base mysql
*/
diff --git a/htdocs/lib/databases/mysqli.lib.php b/htdocs/lib/databases/mysqli.lib.php
index 10065585d6d..f4828400c26 100644
--- a/htdocs/lib/databases/mysqli.lib.php
+++ b/htdocs/lib/databases/mysqli.lib.php
@@ -23,7 +23,7 @@
*/
/**
- \file htdocs/lib/mysqli.lib.php
+ \file htdocs/lib/databases/mysqli.lib.php
\brief Fichier de la classe permettant de g�rer une base mysql
*/
diff --git a/htdocs/lib/databases/pgsql.lib.php b/htdocs/lib/databases/pgsql.lib.php
index a582cced11c..4711bb52663 100644
--- a/htdocs/lib/databases/pgsql.lib.php
+++ b/htdocs/lib/databases/pgsql.lib.php
@@ -23,7 +23,7 @@
*/
/**
- \file htdocs/lib/pgsql.lib.php
+ \file htdocs/lib/databases/pgsql.lib.php
\brief Fichier de la classe permettant de g�r�r une base pgsql
*/
diff --git a/htdocs/propal.class.php b/htdocs/propal.class.php
index a1747d821e8..81060ebfc07 100644
--- a/htdocs/propal.class.php
+++ b/htdocs/propal.class.php
@@ -126,7 +126,6 @@ class Propal extends CommonObject
* \param idproduct Id du produit � ajouter
* \param qty Quantit�
* \param remise_percent Remise relative effectu�e sur le produit
- * \return void
* \remarks $this->client doit etre charg�
* \TODO Remplacer les appels a cette fonction par generation objet Ligne
* ins�r� dans tableau $this->products
@@ -369,11 +368,11 @@ class Propal extends CommonObject
/**
* \brief Mise � jour d'une ligne de produit
- * \param id Id de la ligne
+ * \param rowid Id de la ligne
* \param pu Prix unitaire (HT ou TTC selon price_base_type)
* \param qty Quantit�
* \param remise_percent Remise effectu�e sur le produit
- * \param tva_tx Taux de TVA
+ * \param txtva Taux de TVA
* \param desc Description
* \param price_base_type HT ou TTC
* \return int 0 en cas de succ�s
@@ -1725,8 +1724,8 @@ class Propal extends CommonObject
/**
* \brief Change le mode de r�glement
- * \param mode Id du nouveau mode
- * \return int >0 si ok, <0 si ko
+ * \param mode_reglement Id du nouveau mode
+ * \return int >0 si ok, <0 si ko
*/
function mode_reglement($mode_reglement_id)
{
@@ -2212,7 +2211,7 @@ class Propal extends CommonObject
\brief Renvoie nom clicable (avec eventuellement le picto)
\param withpicto 0=Pas de picto, 1=Inclut le picto dans le lien, 2=Picto seul
\param option Sur quoi pointe le lien
- \param get_param Parametres ajout� � l'url
+ \param get_params Parametres added to url
\return string Chaine avec URL
*/
function getNomUrl($withpicto=0,$option='', $get_params='')
diff --git a/htdocs/translate.class.php b/htdocs/translate.class.php
index ce3647450fb..c1356bf24f3 100644
--- a/htdocs/translate.class.php
+++ b/htdocs/translate.class.php
@@ -263,8 +263,9 @@ class Translate {
* Les param�tres de cette m�thode peuvent contenir de balises HTML.
* \param key cl� de chaine a traduire
* \param param1 chaine de param1
- * \param param2 chaine de param1
- * \param param3 chaine de param1
+ * \param param2 chaine de param2
+ * \param param3 chaine de param3
+ * \param param4 chaine de param4
* \param maxsize taille max
* \return string chaine traduite et cod� en HTML
*/
diff --git a/htdocs/user.class.php b/htdocs/user.class.php
index 4b7a938c590..399f1efc263 100644
--- a/htdocs/user.class.php
+++ b/htdocs/user.class.php
@@ -478,7 +478,7 @@ class User extends CommonObject
/**
\brief Charge dans l'objet user, la liste des permissions auxquelles l'utilisateur a droit
- \param module nom du module dont il faut recuperer les droits ('' par defaut signifie tous les droits)
+ \param moduletag nom du module dont il faut recuperer les droits ('' par defaut signifie tous les droits)
*/
function getrights($moduletag='')
{
diff --git a/htdocs/webcal/webcal.class.php b/htdocs/webcal/webcal.class.php
index 294f86cc2fe..e305a3a1b2b 100644
--- a/htdocs/webcal/webcal.class.php
+++ b/htdocs/webcal/webcal.class.php
@@ -181,7 +181,7 @@ class Webcal {
\param type 'event' or 'journal'
\param cachedelay Do not rebuild file if date older than cachedelay seconds
\param filename Force filename
- \param filter Array of filters
+ \param filters Array of filters
\return int <0 if error, nb of events in new file if ok
*/
function build_calfile($format,$type,$cachedelay,$filename,$filters)
--
GitLab