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,7 +18,8 @@
* *
*/ */
/*! \file XML-RPC.functions.php /*! \file htdocs/adherents/XML-RPC.functions.php
\ingroup adherent
\brief Fichier de gestion XML-RPC pour dolibarr \brief Fichier de gestion XML-RPC pour dolibarr
\author Keith Devens \author Keith Devens
\author Jean-Louis Bergamo \author Jean-Louis Bergamo
@ -27,7 +28,6 @@
*/ */
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,7 +22,8 @@
* *
*/ */
/*! \file adherent.class.php /*! \file htdocs/adherents/adherent.class.php
\ingroup adherent
\brief Fichier de la classe permettant la gestion d'un adhérent \brief Fichier de la classe permettant la gestion d'un adhérent
\author Rodolphe Qiedeville \author Rodolphe Qiedeville
\author Jean-Louis Bergamo \author Jean-Louis Bergamo
@ -30,11 +31,11 @@
\version $Revision$ \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,7 +21,8 @@
* *
*/ */
/*! \file adherent_options.class.php /*! \file htdocs/adherents/adherent_options.class.php
\ingroup adherent
\brief Fichier de la classe de gestion de la table des champs optionels adhérents \brief Fichier de la classe de gestion de la table des champs optionels adhérents
\author Rodolphe Quiedville \author Rodolphe Quiedville
\author Jean-Louis Bergamo \author Jean-Louis Bergamo

View File

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

View File

@ -58,7 +58,9 @@
//require_once('fpdf.php'); //require_once('fpdf.php');
/*! \file PDF_card.class.php
/*! \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é \brief Fichier de la classe permettant d'éditer au format PDF des étiquettes au format Avery ou personnalisé
\author Steve Dillon \author Steve Dillon
\author Laurent Passebecq \author Laurent Passebecq

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,7 +20,8 @@
* *
*/ */
/*! \file cotisation.class.php /*! \file htdocs/adherents/cotisation.class.php
\ingroup adherent
\brief Fichier de la classe permettant de gèrer les cotisations \brief Fichier de la classe permettant de gèrer les cotisations
\author Rodolphe Quiedeville \author Rodolphe Quiedeville
\version $Revision$ \version $Revision$

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");