From dbda2a8ac9608e515a7e7729e92467f66c9e5b85 Mon Sep 17 00:00:00 2001
From: Laurent Destailleur <eldy@users.sourceforge.net>
Date: Sat, 14 Aug 2004 12:37:59 +0000
Subject: [PATCH] =?UTF-8?q?Doc:=20Tous=20les=20fichiers=20de=20l'espace=20?=
=?UTF-8?q?adherents=20sont=20d=E9crits=20dans=20doxygen.?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
htdocs/adherents/XML-RPC.functions.php | 14 +++++++-------
htdocs/adherents/adherent.class.php | 17 +++++++++--------
htdocs/adherents/adherent_options.class.php | 13 +++++++------
htdocs/adherents/adherent_type.class.php | 11 ++++++-----
htdocs/adherents/cartes/PDF_card.class.php | 16 +++++++++-------
htdocs/adherents/cartes/carte.php | 7 +++++++
htdocs/adherents/cartes/etiquette.php | 7 +++++++
htdocs/adherents/cartes/pre.inc.php | 7 +++++++
htdocs/adherents/cotisation.class.php | 11 ++++++-----
htdocs/adherents/cotisations.php | 7 +++++++
htdocs/adherents/edit.php | 7 +++++++
htdocs/adherents/fiche.php | 7 +++++++
htdocs/adherents/htpasswd.php | 8 ++++++++
htdocs/adherents/index.php | 8 ++++++++
htdocs/adherents/liste.php | 7 +++++++
htdocs/adherents/options.php | 7 +++++++
htdocs/adherents/pre.inc.php | 7 +++++++
htdocs/adherents/type.php | 7 +++++++
18 files changed, 130 insertions(+), 38 deletions(-)
diff --git a/htdocs/adherents/XML-RPC.functions.php b/htdocs/adherents/XML-RPC.functions.php
index 43bafe58453..caf23ff5505 100644
--- a/htdocs/adherents/XML-RPC.functions.php
+++ b/htdocs/adherents/XML-RPC.functions.php
@@ -18,16 +18,16 @@
*
*/
-/*! \file XML-RPC.functions.php
- \brief Fichier de gestion XML-RPC pour dolibarr
- \author Keith Devens
- \author Jean-Louis Bergamo
- \auhtor Laurent Destailleur
- \version $Revision$
+/*! \file htdocs/adherents/XML-RPC.functions.php
+ \ingroup adherent
+ \brief Fichier de gestion XML-RPC pour dolibarr
+ \author Keith Devens
+ \author Jean-Louis Bergamo
+ \auhtor Laurent Destailleur
+ \version $Revision$
*/
-
function & XML_serialize(&$data, $level = 0, $prior_key = NULL){
#assumes a hash, keys are the variable names
$xml_serialized_string = "";
diff --git a/htdocs/adherents/adherent.class.php b/htdocs/adherents/adherent.class.php
index 2f39ae7c01c..deaac8322e7 100644
--- a/htdocs/adherents/adherent.class.php
+++ b/htdocs/adherents/adherent.class.php
@@ -22,19 +22,20 @@
*
*/
-/*! \file adherent.class.php
- \brief Fichier de la classe permettant la gestion d'un adh�rent
- \author Rodolphe Qiedeville
- \author Jean-Louis Bergamo
- \author Laurent Destailleur
- \version $Revision$
+/*! \file htdocs/adherents/adherent.class.php
+ \ingroup adherent
+ \brief Fichier de la classe permettant la gestion d'un adh�rent
+ \author Rodolphe Qiedeville
+ \author Jean-Louis Bergamo
+ \author Laurent Destailleur
+ \version $Revision$
*/
+
/*! \class Adherent
- \brief Classe permettant la gestion d'un adh�rent
+ \brief Classe permettant la gestion d'un adh�rent
*/
-
class Adherent
{
var $id;
diff --git a/htdocs/adherents/adherent_options.class.php b/htdocs/adherents/adherent_options.class.php
index e66f61200b6..e4b77acf8d8 100644
--- a/htdocs/adherents/adherent_options.class.php
+++ b/htdocs/adherents/adherent_options.class.php
@@ -21,15 +21,16 @@
*
*/
-/*! \file adherent_options.class.php
- \brief Fichier de la classe de gestion de la table des champs optionels adh�rents
- \author Rodolphe Quiedville
- \author Jean-Louis Bergamo
- \version $Revision$
+/*! \file htdocs/adherents/adherent_options.class.php
+ \ingroup adherent
+ \brief Fichier de la classe de gestion de la table des champs optionels adh�rents
+ \author Rodolphe Quiedville
+ \author Jean-Louis Bergamo
+ \version $Revision$
*/
/*! \class AdherentOptions
- \brief Classe de gestion de la table des champs optionels adh�rents
+ \brief Classe de gestion de la table des champs optionels adh�rents
*/
class AdherentOptions
diff --git a/htdocs/adherents/adherent_type.class.php b/htdocs/adherents/adherent_type.class.php
index e704663c498..1066b56eff2 100644
--- a/htdocs/adherents/adherent_type.class.php
+++ b/htdocs/adherents/adherent_type.class.php
@@ -20,14 +20,15 @@
*
*/
-/*! \file adherent_type.class.php
- \brief Fichier de la classe g�rant les types d'adh�rents
- \author Rodolphe Quiedeville
- \version $Revision$
+/*! \file htdocs/adherents/adherent_type.class.php
+ \ingroup adherent
+ \brief Fichier de la classe g�rant les types d'adh�rents
+ \author Rodolphe Quiedeville
+ \version $Revision$
*/
/*! \class AdherentType
- \brief Classe g�rant les types d'adh�rents
+ \brief Classe g�rant les types d'adh�rents
*/
diff --git a/htdocs/adherents/cartes/PDF_card.class.php b/htdocs/adherents/cartes/PDF_card.class.php
index a210966080c..3dc46b87b74 100755
--- a/htdocs/adherents/cartes/PDF_card.class.php
+++ b/htdocs/adherents/cartes/PDF_card.class.php
@@ -58,13 +58,15 @@
//require_once('fpdf.php');
-/*! \file PDF_card.class.php
- \brief Fichier de la classe permettant d'�diter au format PDF des �tiquettes au format Avery ou personnalis�
- \author Steve Dillon
- \author Laurent Passebecq
- \author Rodolphe Quiedville
- \author Jean Louis Bergamo.
- \version $Revision$
+
+/*! \file htdocs/adherents/cartes/PDF_card.class.php
+ \ingroup adherent
+ \brief Fichier de la classe permettant d'�diter au format PDF des �tiquettes au format Avery ou personnalis�
+ \author Steve Dillon
+ \author Laurent Passebecq
+ \author Rodolphe Quiedville
+ \author Jean Louis Bergamo.
+ \version $Revision$
*/
/*! \class PDF_card
diff --git a/htdocs/adherents/cartes/carte.php b/htdocs/adherents/cartes/carte.php
index cce4f6a2b09..5742842fe3f 100755
--- a/htdocs/adherents/cartes/carte.php
+++ b/htdocs/adherents/cartes/carte.php
@@ -20,6 +20,13 @@
* $Source$
*
*/
+
+/*! \file htdocs/adherents/cartes/carte.php
+ \ingroup adherent
+ \brief Page de creation d'une carte PDF
+ \version $Revision$
+*/
+
require("./pre.inc.php");
require(DOL_DOCUMENT_ROOT."/adherents/adherent.class.php");
diff --git a/htdocs/adherents/cartes/etiquette.php b/htdocs/adherents/cartes/etiquette.php
index 49563c41e5a..48337cec883 100755
--- a/htdocs/adherents/cartes/etiquette.php
+++ b/htdocs/adherents/cartes/etiquette.php
@@ -20,6 +20,13 @@
* $Source$
*
*/
+
+/*! \file htdocs/adherents/cartes/etiquette.php
+ \ingroup adherent
+ \brief Page de creation d'etiquettes
+ \version $Revision$
+*/
+
require("./pre.inc.php");
require(DOL_DOCUMENT_ROOT."/adherents/adherent.class.php");
diff --git a/htdocs/adherents/cartes/pre.inc.php b/htdocs/adherents/cartes/pre.inc.php
index 2f252b22abf..502adab3fb2 100644
--- a/htdocs/adherents/cartes/pre.inc.php
+++ b/htdocs/adherents/cartes/pre.inc.php
@@ -19,6 +19,13 @@
* $Source$
*
*/
+
+/*! \file htdocs/adherents/cartes/pre.inc.php
+ \ingroup adherent
+ \brief Fichier de gestion du menu gauche du module adherent
+ \version $Revision$
+*/
+
require("../../main.inc.php");
function llxHeader($head = "") {
diff --git a/htdocs/adherents/cotisation.class.php b/htdocs/adherents/cotisation.class.php
index 8521a313986..507e34c6240 100644
--- a/htdocs/adherents/cotisation.class.php
+++ b/htdocs/adherents/cotisation.class.php
@@ -20,14 +20,15 @@
*
*/
-/*! \file cotisation.class.php
- \brief Fichier de la classe permettant de g�rer les cotisations
- \author Rodolphe Quiedeville
- \version $Revision$
+/*! \file htdocs/adherents/cotisation.class.php
+ \ingroup adherent
+ \brief Fichier de la classe permettant de g�rer les cotisations
+ \author Rodolphe Quiedeville
+ \version $Revision$
*/
/*! \class Cotisation
- \brief Classe permettant de g�rer les cotisations
+ \brief Classe permettant de g�rer les cotisations
*/
class Cotisation
diff --git a/htdocs/adherents/cotisations.php b/htdocs/adherents/cotisations.php
index f826c0e483a..ff1c138aaa9 100644
--- a/htdocs/adherents/cotisations.php
+++ b/htdocs/adherents/cotisations.php
@@ -21,6 +21,13 @@
* $Source$
*
*/
+
+/*! \file htdocs/adherents/cotisations.php
+ \ingroup adherent
+ \brief Page de consultation et insertion d'une cotisation
+ \version $Revision$
+*/
+
require("./pre.inc.php");
require(DOL_DOCUMENT_ROOT."/compta/bank/account.class.php");
diff --git a/htdocs/adherents/edit.php b/htdocs/adherents/edit.php
index 9fe882910f2..c2749fa4f4d 100644
--- a/htdocs/adherents/edit.php
+++ b/htdocs/adherents/edit.php
@@ -21,6 +21,13 @@
* $Source$
*
*/
+
+/*! \file htdocs/adherents/edit.php
+ \ingroup adherent
+ \brief Page d'edition d'un adherent
+ \version $Revision$
+*/
+
require("./pre.inc.php");
require(DOL_DOCUMENT_ROOT."/adherents/adherent.class.php");
require(DOL_DOCUMENT_ROOT."/adherents/adherent_type.class.php");
diff --git a/htdocs/adherents/fiche.php b/htdocs/adherents/fiche.php
index 4e9e4ceeade..a87facc308b 100644
--- a/htdocs/adherents/fiche.php
+++ b/htdocs/adherents/fiche.php
@@ -21,6 +21,13 @@
* $Source$
*
*/
+
+/*! \file htdocs/adherents/fiche.php
+ \ingroup adherent
+ \brief Page d'ajout, edition, suppression d'une fiche adh�rent
+ \version $Revision$
+*/
+
require("./pre.inc.php");
$langs->load("companies");
diff --git a/htdocs/adherents/htpasswd.php b/htdocs/adherents/htpasswd.php
index 94e057151f9..be42861e6a8 100644
--- a/htdocs/adherents/htpasswd.php
+++ b/htdocs/adherents/htpasswd.php
@@ -20,6 +20,14 @@
* $Source$
*
*/
+
+/*! \file htdocs/adherents/htpasswd.php
+ \ingroup adherent
+ \brief Page d'export htpasswd du fichier des adherents
+ \author Rodolphe Quiedeville
+ \version $Revision$
+*/
+
require("./pre.inc.php");
llxHeader();
diff --git a/htdocs/adherents/index.php b/htdocs/adherents/index.php
index 014433b4e9e..02ef535cae0 100644
--- a/htdocs/adherents/index.php
+++ b/htdocs/adherents/index.php
@@ -21,6 +21,14 @@
* $Source$
*
*/
+
+/*!
+ \file htdocs/adherents/index.php
+ \ingroup adherent
+ \brief Page accueil module adherents
+*/
+
+
require("./pre.inc.php");
$langs->load("companies");
diff --git a/htdocs/adherents/liste.php b/htdocs/adherents/liste.php
index 68de47c732f..bc762071090 100644
--- a/htdocs/adherents/liste.php
+++ b/htdocs/adherents/liste.php
@@ -21,6 +21,13 @@
* $Source$
*
*/
+
+/*! \file htdocs/adherents/liste.php
+ \ingroup adherent
+ \brief Page listant les adh�rents
+ \version $Revision$
+*/
+
require("./pre.inc.php");
require("./adherent.class.php");
diff --git a/htdocs/adherents/options.php b/htdocs/adherents/options.php
index eeb13af49d3..ab62ea19526 100644
--- a/htdocs/adherents/options.php
+++ b/htdocs/adherents/options.php
@@ -21,6 +21,13 @@
* $Source$
*
*/
+
+/*! \file htdocs/adherents/options.php
+ \ingroup adherent
+ \brief Page de configuratin des champs optionnels
+ \version $Revision$
+*/
+
require("./pre.inc.php");
require(DOL_DOCUMENT_ROOT."/adherents/adherent_options.class.php");
diff --git a/htdocs/adherents/pre.inc.php b/htdocs/adherents/pre.inc.php
index 2deb7e81df0..49765ee6df5 100644
--- a/htdocs/adherents/pre.inc.php
+++ b/htdocs/adherents/pre.inc.php
@@ -20,6 +20,13 @@
* $Source$
*
*/
+
+/*! \file htdocs/adherents/pre.inc.php
+ \ingroup adherent
+ \brief Fichier de gestion du menu gauche du module adherent
+ \version $Revision$
+*/
+
require("../main.inc.php");
function llxHeader($head = "") {
diff --git a/htdocs/adherents/type.php b/htdocs/adherents/type.php
index e3a8796a4f1..7d4b1b27dfd 100644
--- a/htdocs/adherents/type.php
+++ b/htdocs/adherents/type.php
@@ -21,6 +21,13 @@
* $Source$
*
*/
+
+/*! \file htdocs/adherents/type.php
+ \ingroup adherent
+ \brief Page de configuration des types d'adh�rents
+ \version $Revision$
+*/
+
require("./pre.inc.php");
require(DOL_DOCUMENT_ROOT."/adherents/adherent.class.php");
require(DOL_DOCUMENT_ROOT."/adherents/adherent_type.class.php");
--
GitLab