Doc: Tous les fichiers de l'espace adherents sont décrits dans doxygen.

This commit is contained in:
Laurent Destailleur 2004-08-14 12:37:59 +00:00
parent c385b8815c
commit dbda2a8ac9
18 changed files with 130 additions and 38 deletions

View File

@ -18,16 +18,16 @@
* *
*/ */
/*! \file XML-RPC.functions.php /*! \file htdocs/adherents/XML-RPC.functions.php
\brief Fichier de gestion XML-RPC pour dolibarr \ingroup adherent
\author Keith Devens \brief Fichier de gestion XML-RPC pour dolibarr
\author Jean-Louis Bergamo \author Keith Devens
\auhtor Laurent Destailleur \author Jean-Louis Bergamo
\version $Revision$ \auhtor Laurent Destailleur
\version $Revision$
*/ */
function & XML_serialize(&$data, $level = 0, $prior_key = NULL){ function & XML_serialize(&$data, $level = 0, $prior_key = NULL){
#assumes a hash, keys are the variable names #assumes a hash, keys are the variable names
$xml_serialized_string = ""; $xml_serialized_string = "";

View File

@ -22,19 +22,20 @@
* *
*/ */
/*! \file adherent.class.php /*! \file htdocs/adherents/adherent.class.php
\brief Fichier de la classe permettant la gestion d'un adhérent \ingroup adherent
\author Rodolphe Qiedeville \brief Fichier de la classe permettant la gestion d'un adhérent
\author Jean-Louis Bergamo \author Rodolphe Qiedeville
\author Laurent Destailleur \author Jean-Louis Bergamo
\version $Revision$ \author Laurent Destailleur
\version $Revision$
*/ */
/*! \class Adherent /*! \class Adherent
\brief Classe permettant la gestion d'un adhérent \brief Classe permettant la gestion d'un adhérent
*/ */
class Adherent class Adherent
{ {
var $id; var $id;

View File

@ -21,15 +21,16 @@
* *
*/ */
/*! \file adherent_options.class.php /*! \file htdocs/adherents/adherent_options.class.php
\brief Fichier de la classe de gestion de la table des champs optionels adhérents \ingroup adherent
\author Rodolphe Quiedville \brief Fichier de la classe de gestion de la table des champs optionels adhérents
\author Jean-Louis Bergamo \author Rodolphe Quiedville
\version $Revision$ \author Jean-Louis Bergamo
\version $Revision$
*/ */
/*! \class AdherentOptions /*! \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 class AdherentOptions

View File

@ -20,14 +20,15 @@
* *
*/ */
/*! \file adherent_type.class.php /*! \file htdocs/adherents/adherent_type.class.php
\brief Fichier de la classe gérant les types d'adhérents \ingroup adherent
\author Rodolphe Quiedeville \brief Fichier de la classe gérant les types d'adhérents
\version $Revision$ \author Rodolphe Quiedeville
\version $Revision$
*/ */
/*! \class AdherentType /*! \class AdherentType
\brief Classe gérant les types d'adhérents \brief Classe gérant les types d'adhérents
*/ */

View File

@ -58,13 +58,15 @@
//require_once('fpdf.php'); //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é /*! \file htdocs/adherents/cartes/PDF_card.class.php
\author Steve Dillon \ingroup adherent
\author Laurent Passebecq \brief Fichier de la classe permettant d'éditer au format PDF des étiquettes au format Avery ou personnalisé
\author Rodolphe Quiedville \author Steve Dillon
\author Jean Louis Bergamo. \author Laurent Passebecq
\version $Revision$ \author Rodolphe Quiedville
\author Jean Louis Bergamo.
\version $Revision$
*/ */
/*! \class PDF_card /*! \class PDF_card

View File

@ -20,6 +20,13 @@
* $Source$ * $Source$
* *
*/ */
/*! \file htdocs/adherents/cartes/carte.php
\ingroup adherent
\brief Page de creation d'une carte PDF
\version $Revision$
*/
require("./pre.inc.php"); require("./pre.inc.php");
require(DOL_DOCUMENT_ROOT."/adherents/adherent.class.php"); require(DOL_DOCUMENT_ROOT."/adherents/adherent.class.php");

View File

@ -20,6 +20,13 @@
* $Source$ * $Source$
* *
*/ */
/*! \file htdocs/adherents/cartes/etiquette.php
\ingroup adherent
\brief Page de creation d'etiquettes
\version $Revision$
*/
require("./pre.inc.php"); require("./pre.inc.php");
require(DOL_DOCUMENT_ROOT."/adherents/adherent.class.php"); require(DOL_DOCUMENT_ROOT."/adherents/adherent.class.php");

View File

@ -19,6 +19,13 @@
* $Source$ * $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"); require("../../main.inc.php");
function llxHeader($head = "") { function llxHeader($head = "") {

View File

@ -20,14 +20,15 @@
* *
*/ */
/*! \file cotisation.class.php /*! \file htdocs/adherents/cotisation.class.php
\brief Fichier de la classe permettant de gèrer les cotisations \ingroup adherent
\author Rodolphe Quiedeville \brief Fichier de la classe permettant de gèrer les cotisations
\version $Revision$ \author Rodolphe Quiedeville
\version $Revision$
*/ */
/*! \class Cotisation /*! \class Cotisation
\brief Classe permettant de gèrer les cotisations \brief Classe permettant de gèrer les cotisations
*/ */
class Cotisation class Cotisation

View File

@ -21,6 +21,13 @@
* $Source$ * $Source$
* *
*/ */
/*! \file htdocs/adherents/cotisations.php
\ingroup adherent
\brief Page de consultation et insertion d'une cotisation
\version $Revision$
*/
require("./pre.inc.php"); require("./pre.inc.php");
require(DOL_DOCUMENT_ROOT."/compta/bank/account.class.php"); require(DOL_DOCUMENT_ROOT."/compta/bank/account.class.php");

View File

@ -21,6 +21,13 @@
* $Source$ * $Source$
* *
*/ */
/*! \file htdocs/adherents/edit.php
\ingroup adherent
\brief Page d'edition d'un adherent
\version $Revision$
*/
require("./pre.inc.php"); require("./pre.inc.php");
require(DOL_DOCUMENT_ROOT."/adherents/adherent.class.php"); require(DOL_DOCUMENT_ROOT."/adherents/adherent.class.php");
require(DOL_DOCUMENT_ROOT."/adherents/adherent_type.class.php"); require(DOL_DOCUMENT_ROOT."/adherents/adherent_type.class.php");

View File

@ -21,6 +21,13 @@
* $Source$ * $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"); require("./pre.inc.php");
$langs->load("companies"); $langs->load("companies");

View File

@ -20,6 +20,14 @@
* $Source$ * $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"); require("./pre.inc.php");
llxHeader(); llxHeader();

View File

@ -21,6 +21,14 @@
* $Source$ * $Source$
* *
*/ */
/*!
\file htdocs/adherents/index.php
\ingroup adherent
\brief Page accueil module adherents
*/
require("./pre.inc.php"); require("./pre.inc.php");
$langs->load("companies"); $langs->load("companies");

View File

@ -21,6 +21,13 @@
* $Source$ * $Source$
* *
*/ */
/*! \file htdocs/adherents/liste.php
\ingroup adherent
\brief Page listant les adhérents
\version $Revision$
*/
require("./pre.inc.php"); require("./pre.inc.php");
require("./adherent.class.php"); require("./adherent.class.php");

View File

@ -21,6 +21,13 @@
* $Source$ * $Source$
* *
*/ */
/*! \file htdocs/adherents/options.php
\ingroup adherent
\brief Page de configuratin des champs optionnels
\version $Revision$
*/
require("./pre.inc.php"); require("./pre.inc.php");
require(DOL_DOCUMENT_ROOT."/adherents/adherent_options.class.php"); require(DOL_DOCUMENT_ROOT."/adherents/adherent_options.class.php");

View File

@ -20,6 +20,13 @@
* $Source$ * $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"); require("../main.inc.php");
function llxHeader($head = "") { function llxHeader($head = "") {

View File

@ -21,6 +21,13 @@
* $Source$ * $Source$
* *
*/ */
/*! \file htdocs/adherents/type.php
\ingroup adherent
\brief Page de configuration des types d'adhérents
\version $Revision$
*/
require("./pre.inc.php"); require("./pre.inc.php");
require(DOL_DOCUMENT_ROOT."/adherents/adherent.class.php"); require(DOL_DOCUMENT_ROOT."/adherents/adherent.class.php");
require(DOL_DOCUMENT_ROOT."/adherents/adherent_type.class.php"); require(DOL_DOCUMENT_ROOT."/adherents/adherent_type.class.php");