This commit is contained in:
Laurent Destailleur 2010-07-21 11:57:52 +00:00
parent d46ed0c984
commit 87ce3073d5
35 changed files with 112 additions and 101 deletions

View File

@ -22,7 +22,7 @@
/** /**
* \file htdocs/adherents/admin/adherent.php * \file htdocs/adherents/admin/adherent.php
* \ingroup adherent * \ingroup member
* \brief Page to setup the module Foundation * \brief Page to setup the module Foundation
* \version $Id$ * \version $Id$
*/ */

View File

@ -20,7 +20,7 @@
/** /**
* \file htdocs/adherents/cartes/carte.php * \file htdocs/adherents/cartes/carte.php
* \ingroup adherent * \ingroup member
* \brief Page to output members business cards * \brief Page to output members business cards
* \version $Id$ * \version $Id$
*/ */

View File

@ -20,7 +20,7 @@
/** /**
* \file htdocs/adherents/cartes/etiquette.php * \file htdocs/adherents/cartes/etiquette.php
* \ingroup adherent * \ingroup member
* \brief Page de creation d'etiquettes * \brief Page de creation d'etiquettes
* \version $Id$ * \version $Id$
*/ */

View File

@ -22,7 +22,7 @@
/** /**
* \file htdocs/admin/ldap_members.php * \file htdocs/admin/ldap_members.php
* \ingroup ldap adherent * \ingroup ldap member
* \brief Page d'administration/configuration du module Ldap adherent * \brief Page d'administration/configuration du module Ldap adherent
* \version $Id$ * \version $Id$
*/ */

View File

@ -30,7 +30,6 @@
* \class Address * \class Address
* \brief Classe permettant la gestion des adresses des tiers * \brief Classe permettant la gestion des adresses des tiers
*/ */
class Address class Address
{ {
var $db; var $db;
@ -470,6 +469,11 @@ class Address
} }
/**
* \class AddressLine
* \brief Class to manage one address line
*/
class AddressLine class AddressLine
{ {

View File

@ -2220,7 +2220,7 @@ class Propal extends CommonObject
/** /**
* \class PropalLigne * \class PropaleLigne
* \brief Class to manage commercial proposal lines * \brief Class to manage commercial proposal lines
*/ */
class PropaleLigne class PropaleLigne

View File

@ -20,19 +20,18 @@
* $Id$ * $Id$
*/ */
/* /**
\file htdocs/compta/prelevement/rejet-prelevement.class.php \file htdocs/compta/prelevementclass//rejet-prelevement.class.php
\ingroup prelevement \ingroup prelevement
\brief Fichier de la classe des prelevements \brief File of class to manage standing orders rejects
\version $Revision$ \version $Revision$
*/ */
/** /**
\class Prelevement \class Prelevement
\brief Classe permettant la gestion des prelevements \brief Class to manage standing orders rejects
*/ */
class RejetPrelevement class RejetPrelevement
{ {
var $id; var $id;

View File

@ -23,6 +23,11 @@
* \brief File of class to manage cookies * \brief File of class to manage cookies
*/ */
/**
* \class DolCookie
* \brief Class to manage cookies
*/
class DolCookie class DolCookie
{ {
var $myKey; var $myKey;

View File

@ -37,8 +37,8 @@
/** /**
* \class Graph * \class DolGraph
* \brief Classe mere permettant la gestion des graph * \brief Parent class of graph classes
*/ */
class DolGraph class DolGraph
{ {

View File

@ -18,7 +18,7 @@
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/ */
/** \file htdocs/fichinter/fichinter.class.php /** \file htdocs/fichinter/class/fichinter.class.php
* \ingroup ficheinter * \ingroup ficheinter
* \brief Fichier de la classe des gestion des fiches interventions * \brief Fichier de la classe des gestion des fiches interventions
* \version $Id$ * \version $Id$
@ -28,7 +28,7 @@ require_once(DOL_DOCUMENT_ROOT ."/core/class/commonobject.class.php");
/** /**
* \class Ficheinter * \class Fichinter
* \brief Classe des gestion des fiches interventions * \brief Classe des gestion des fiches interventions
*/ */
class Fichinter extends CommonObject class Fichinter extends CommonObject

View File

@ -19,12 +19,11 @@
*/ */
/** /**
* \file htdocs/fourn/fournisseur.class.php * \file htdocs/fourn/class/fournisseur.class.php
* \ingroup fournisseur,societe * \ingroup fournisseur,societe
* \brief Fichier de la classe des fournisseurs * \brief File of class to manage suppliers
* \version $Id$ * \version $Id$
*/ */
require_once(DOL_DOCUMENT_ROOT."/societe/class/societe.class.php"); require_once(DOL_DOCUMENT_ROOT."/societe/class/societe.class.php");
require_once(DOL_DOCUMENT_ROOT."/fourn/class/fournisseur.commande.class.php"); require_once(DOL_DOCUMENT_ROOT."/fourn/class/fournisseur.commande.class.php");
require_once(DOL_DOCUMENT_ROOT."/fourn/class/fournisseur.product.class.php"); require_once(DOL_DOCUMENT_ROOT."/fourn/class/fournisseur.product.class.php");
@ -32,9 +31,8 @@ require_once(DOL_DOCUMENT_ROOT."/fourn/class/fournisseur.product.class.php");
/** /**
* \class Fournisseur * \class Fournisseur
* \brief Classe permettant la gestion des fournisseur * \brief Class to manage suppliers
*/ */
class Fournisseur extends Societe class Fournisseur extends Societe
{ {
var $db; var $db;

View File

@ -21,9 +21,9 @@
*/ */
/** /**
* \file htdocs/fourn/fournisseur.commande.class.php * \file htdocs/fourn/classfournisseur.commande.class.php
* \ingroup fournisseur,commande * \ingroup fournisseur,commande
* \brief Fichier des classes des commandes fournisseurs * \brief File of class to manage suppliers orders
* \version $Id$ * \version $Id$
*/ */
@ -33,7 +33,7 @@ require_once(DOL_DOCUMENT_ROOT."/commande/class/commande.class.php");
/** /**
* \class CommandeFournisseur * \class CommandeFournisseur
* \brief Classe de gestion de commande fournisseur * \brief Class to manage predefined suppliers products
*/ */
class CommandeFournisseur extends Commande class CommandeFournisseur extends Commande
{ {

View File

@ -22,9 +22,9 @@
*/ */
/** /**
* \file htdocs/fourn/fournisseur.facture.class.php * \file htdocs/fourn/class/fournisseur.facture.class.php
* \ingroup fournisseur,facture * \ingroup fournisseur,facture
* \brief Fichier de la classe des factures fournisseurs * \brief File of class to manage suppliers invoices
* \version $Id$ * \version $Id$
*/ */
@ -33,7 +33,7 @@ include_once(DOL_DOCUMENT_ROOT."/compta/facture/class/facture.class.php");
/** /**
* \class FactureFournisseur * \class FactureFournisseur
* \brief Classe permettant la gestion des factures fournisseurs * \brief Class to manage suppliers invoices
*/ */
class FactureFournisseur extends Facture class FactureFournisseur extends Facture
{ {

View File

@ -19,9 +19,9 @@
*/ */
/** /**
* \file htdocs/fourn/fournisseur.product.class.php * \file htdocs/fourn/class/fournisseur.product.class.php
* \ingroup produit * \ingroup produit
* \brief Fichier de la classe des produits predefinis * \brief File of class to manage predefined suppliers products
* \version $Id$ * \version $Id$
*/ */
@ -30,8 +30,8 @@ require_once DOL_DOCUMENT_ROOT."/fourn/class/fournisseur.class.php";
/** /**
* \class Product * \class ProductFournisseur
* \brief Classe permettant la gestion des produits predefinis * \brief Class to manage predefined suppliers products
*/ */
class ProductFournisseur extends Product class ProductFournisseur extends Product
{ {

View File

@ -20,7 +20,7 @@
/** /**
* \file htdocs/includes/modules/export/export_csv.modules.php * \file htdocs/includes/modules/export/export_csv.modules.php
* \ingroup export * \ingroup export
* \brief File to build exports with CSV format * \brief File of class to build exports with CSV format
* \author Laurent Destailleur * \author Laurent Destailleur
* \version $Id$ * \version $Id$
*/ */
@ -30,7 +30,7 @@ require_once(DOL_DOCUMENT_ROOT ."/includes/modules/export/modules_export.php");
/** /**
* \class ExportCsv * \class ExportCsv
* \brief Classe permettant de generer les fichiers exports au format CSV * \brief Class to build export files with format CSV
*/ */
class ExportCsv extends ModeleExports class ExportCsv extends ModeleExports
{ {

View File

@ -20,7 +20,7 @@
/** /**
* \file htdocs/includes/modules/export/export_csv.modules.php * \file htdocs/includes/modules/export/export_csv.modules.php
* \ingroup export * \ingroup export
* \brief Fichier de la classe permettant de g<EFBFBD>n<EFBFBD>rer les export au format CSV * \brief File of class to build export files with format TSV
* \author Laurent Destailleur * \author Laurent Destailleur
* \version $Id$ * \version $Id$
*/ */
@ -29,8 +29,8 @@ require_once(DOL_DOCUMENT_ROOT ."/includes/modules/export/modules_export.php");
/** /**
* \class ExportCsv * \class ExportTsv
* \brief Classe permettant de g<EFBFBD>n<EFBFBD>rer les factures au mod<EFBFBD>le Crabe * \brief Class to build export files with format TSV
*/ */
class ExportTsv extends ModeleExports class ExportTsv extends ModeleExports
{ {

View File

@ -21,18 +21,17 @@
*/ */
/** /**
\file htdocs/includes/modules/fichinter/mod_arctic.php * \file htdocs/includes/modules/fichinter/mod_arctic.php
\ingroup fiche intervention * \ingroup fiche intervention
\brief Fichier contenant la classe du modèle de numérotation de référence de fiche intervention Arctic * \brief Fichier contenant la classe du mod<EFBFBD>le de num<EFBFBD>rotation de r<EFBFBD>f<EFBFBD>rence de fiche intervention Arctic
\version $Id$ * \version $Id$
*/ */
require_once(DOL_DOCUMENT_ROOT ."/includes/modules/fichinter/modules_fichinter.php"); require_once(DOL_DOCUMENT_ROOT ."/includes/modules/fichinter/modules_fichinter.php");
/** /**
\class mod_arctic * \class mod_arctic
\brief Classe du modèle de numérotation de référence de fiche intervention Arctic * \brief Class to manage numbering of intervention cards with rule Artic.
*/ */
class mod_arctic extends ModeleNumRefFicheinter class mod_arctic extends ModeleNumRefFicheinter
{ {
var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' var $version='dolibarr'; // 'development', 'experimental', 'dolibarr'
@ -46,7 +45,7 @@ class mod_arctic extends ModeleNumRefFicheinter
$this->nom = "arctic"; $this->nom = "arctic";
} }
/** \brief Renvoi la description du modele de numérotation /** \brief Renvoi la description du modele de num<EFBFBD>rotation
* \return string Texte descripif * \return string Texte descripif
*/ */
function info() function info()
@ -84,7 +83,7 @@ class mod_arctic extends ModeleNumRefFicheinter
return $texte; return $texte;
} }
/** \brief Renvoi un exemple de numérotation /** \brief Renvoi un exemple de num<EFBFBD>rotation
* \return string Example * \return string Example
*/ */
function getExample() function getExample()
@ -103,8 +102,8 @@ class mod_arctic extends ModeleNumRefFicheinter
return $numExample; return $numExample;
} }
/** \brief Renvoi prochaine valeur attribuée /** \brief Renvoi prochaine valeur attribu<EFBFBD>e
* \param objsoc Objet société * \param objsoc Objet soci<EFBFBD>t<EFBFBD>
* \param ficheinter Object ficheinter * \param ficheinter Object ficheinter
* \return string Valeur * \return string Valeur
*/ */
@ -114,7 +113,7 @@ class mod_arctic extends ModeleNumRefFicheinter
require_once(DOL_DOCUMENT_ROOT ."/lib/functions2.lib.php"); require_once(DOL_DOCUMENT_ROOT ."/lib/functions2.lib.php");
// On défini critere recherche compteur // On d<EFBFBD>fini critere recherche compteur
$mask=$conf->global->FICHINTER_ARTIC_MASK; $mask=$conf->global->FICHINTER_ARTIC_MASK;
if (! $mask) if (! $mask)

View File

@ -29,7 +29,7 @@ require_once(DOL_DOCUMENT_ROOT ."/includes/modules/fichinter/modules_fichinter.p
/** /**
* \class mod_pacific * \class mod_pacific
* \brief Classe du moderotation de reference de fiche intervention Pacific * \brief Class to manage numbering of intervention cards with rule Pacific.
*/ */
class mod_pacific extends ModeleNumRefFicheinter class mod_pacific extends ModeleNumRefFicheinter
{ {

View File

@ -8,9 +8,20 @@
* Code that need to be changed in this file are marked by "CHANGE THIS" tag. * Code that need to be changed in this file are marked by "CHANGE THIS" tag.
*/ */
/**
* \file htdocs/includes/modules/mailings/dolibarr_services_expired.modules.php
* \ingroup mailing
* \brief File of class to offer a selector of emailing targets with Rule 'services expired'.
* \version $Id$
*/
include_once DOL_DOCUMENT_ROOT.'/includes/modules/mailings/modules_mailings.php'; include_once DOL_DOCUMENT_ROOT.'/includes/modules/mailings/modules_mailings.php';
require_once(DOL_DOCUMENT_ROOT."/lib/functions2.lib.php");
/**
* \class mailing_dolibarr_services_expired
* \brief Class to offer a selector of emailing targets with Rule 'services expired'.
*/
class mailing_dolibarr_services_expired extends MailingTargets class mailing_dolibarr_services_expired extends MailingTargets
{ {
var $name='DolibarrContractsLinesExpired'; var $name='DolibarrContractsLinesExpired';

View File

@ -20,20 +20,18 @@
*/ */
/** /**
\file htdocs/includes/modules/mailings/modules_mailings.php * \file htdocs/includes/modules/mailings/modules_mailings.php
\ingroup mailing * \ingroup mailing
\brief Fichier contenant la classe m<EFBFBD>re des classes de liste de destinataires mailing * \brief File with parent class of emailing target selectors modules
\version $Id$ * \version $Id$
*/ */
require_once(DOL_DOCUMENT_ROOT.'/lib/functions.lib.php'); require_once(DOL_DOCUMENT_ROOT.'/lib/functions.lib.php');
/** /**
\class MailingTargets * \class MailingTargets
\brief Classe m<EFBFBD>re des classes de liste de destinataires mailing * \brief Parent class of emailing target selectors modules
*/ */
class MailingTargets class MailingTargets
{ {
var $db=''; var $db='';

View File

@ -20,19 +20,17 @@
/** /**
* \file htdocs/includes/modules/mailings/peche.modules.php * \file htdocs/includes/modules/mailings/peche.modules.php
* \ingroup mailing * \ingroup mailing
* \brief Fichier de la classe permettant de generer la liste de destinataires Peche * \brief File of class to offer a selector of emailing targets with Rule 'Peche'.
* \version $Id$ * \version $Id$
*/ */
include_once DOL_DOCUMENT_ROOT.'/includes/modules/mailings/modules_mailings.php'; include_once DOL_DOCUMENT_ROOT.'/includes/modules/mailings/modules_mailings.php';
require_once(DOL_DOCUMENT_ROOT."/lib/functions2.lib.php"); require_once(DOL_DOCUMENT_ROOT."/lib/functions2.lib.php");
/** /**
* \class mailing_pomme * \class mailing_peche
* \brief Classe permettant de generer la liste des destinataires Peche * \brief Class to offer a selector of emailing targets with Rule 'Peche'.
*/ */
class mailing_peche extends MailingTargets class mailing_peche extends MailingTargets
{ {
var $name='EmailsFromFile'; // Identifiant du module mailing var $name='EmailsFromFile'; // Identifiant du module mailing

View File

@ -20,20 +20,19 @@
*/ */
/** /**
\file htdocs/includes/modules/mailings/poire.modules.php * \file htdocs/includes/modules/mailings/poire.modules.php
\ingroup mailing * \ingroup mailing
\brief Fichier de la classe permettant de g<EFBFBD>n<EFBFBD>rer la liste de destinataires Poire * \brief File of class to offer a selector of emailing targets with Rule 'Poire'.
\version $Id$ * \version $Id$
*/ */
include_once DOL_DOCUMENT_ROOT.'/includes/modules/mailings/modules_mailings.php'; include_once DOL_DOCUMENT_ROOT.'/includes/modules/mailings/modules_mailings.php';
/** /**
\class mailing_poire * \class mailing_poire
\brief Classe permettant de g<EFBFBD>n<EFBFBD>rer la liste des destinataires Poire * \brief Class to offer a selector of emailing targets with Rule 'Poire'.
*/ */
class mailing_poire extends MailingTargets class mailing_poire extends MailingTargets
{ {
var $name='ContactCompanies'; // Identifiant du module mailing var $name='ContactCompanies'; // Identifiant du module mailing

View File

@ -29,7 +29,7 @@
//////////////////////////////////////////////////// ////////////////////////////////////////////////////
// PDF_Label // PDF_Label
// //
// Classe afin d'<EFBFBD>diter au format PDF des <20>tiquettes // Classe afin d'editer au format PDF des etiquettes
// au format Avery ou personnalis<69> // au format Avery ou personnalis<69>
// //
// //
@ -55,7 +55,7 @@
/** /**
* \file htdocs/adherents/cartes/PDF_card.class.php * \file htdocs/adherents/cartes/PDF_card.class.php
* \ingroup adherent * \ingroup member
* \brief Fichier de la classe permettant d'editer au format PDF des etiquettes au format Avery ou personnalise * \brief Fichier de la classe permettant d'editer au format PDF des etiquettes au format Avery ou personnalise
* \author Steve Dillon * \author Steve Dillon
* \author Laurent Passebecq * \author Laurent Passebecq

View File

@ -21,10 +21,9 @@
*/ */
/** /**
* \file htdocs/includes/modules/facture/modules_facture.php * \file htdocs/includes/modules/members/cards/modules_facture.php
* \ingroup facture * \ingroup member
* \brief Fichier contenant la classe mere de generation des factures en PDF * \brief File of parent class of document generator for members cards.
* et la classe mere de numerotation des factures
* \version $Id$ * \version $Id$
*/ */
@ -34,8 +33,8 @@ require_once(DOL_DOCUMENT_ROOT."/product/class/product.class.php");
/** /**
* \class ModelePDFFactures * \class ModelePDFCards
* \brief Classe mere des modeles de facture * \brief Parent class of document generator for members cards.
*/ */
class ModelePDFCards class ModelePDFCards
{ {

View File

@ -55,7 +55,7 @@
/** /**
* \file htdocs/includes/modules/member/card/pdf_standard.class.php * \file htdocs/includes/modules/member/card/pdf_standard.class.php
* \ingroup adherent * \ingroup member
* \brief Fichier de la classe permettant d'editer au format PDF des etiquettes au format Avery ou personnalise * \brief Fichier de la classe permettant d'editer au format PDF des etiquettes au format Avery ou personnalise
* \author Steve Dillon * \author Steve Dillon
* \author Laurent Passebecq * \author Laurent Passebecq

View File

@ -21,7 +21,7 @@
*/ */
/** /**
* \defgroup adherent Module foundation * \defgroup member Module foundation
* \brief Module to manage members of a foundation * \brief Module to manage members of a foundation
*/ */

View File

@ -35,7 +35,7 @@
include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php"); include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php");
/** /**
* \class modAdherent * \class modAgenda
* \brief Classe de description et activation du module Adherent * \brief Classe de description et activation du module Adherent
*/ */
class modAgenda extends DolibarrModules class modAgenda extends DolibarrModules

View File

@ -30,7 +30,7 @@
include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php"); include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php");
/** \class modImport /** \class modGeoIPMaxmind
* \brief Classe de description et activation du module Import * \brief Classe de description et activation du module Import
*/ */
class modGeoIPMaxmind extends DolibarrModules class modGeoIPMaxmind extends DolibarrModules

View File

@ -32,7 +32,7 @@
include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php"); include_once(DOL_DOCUMENT_ROOT ."/includes/modules/DolibarrModules.class.php");
/** /**
* \class modMailing * \class modNotification
* \brief Classe de description et activation du module Mailing * \brief Classe de description et activation du module Mailing
*/ */
class modNotification extends DolibarrModules class modNotification extends DolibarrModules

View File

@ -28,9 +28,9 @@ require_once(DOL_DOCUMENT_ROOT ."/includes/modules/security/generate/modules_gen
/** /**
\class modGeneratePassNone * \class modGeneratePassNone
\brief Classe permettant de g<EFBFBD>n<EFBFBD>rer un mot de passe selon r<EFBFBD>gle standard * \brief Class to generate a password according to rule 'no password'
*/ */
class modGeneratePassNone extends ModeleGenPassword class modGeneratePassNone extends ModeleGenPassword
{ {
var $id; var $id;

View File

@ -28,9 +28,9 @@ require_once(DOL_DOCUMENT_ROOT ."/includes/modules/security/generate/modules_gen
/** /**
\class modGeneratePassNone * \class modGeneratePassNone
\brief Classe permettant de generer un mot de passe selon regle standard * \brief Class to generate a password according to a dolibarr standard rule (8 random chars)
*/ */
class modGeneratePassStandard extends ModeleGenPassword class modGeneratePassStandard extends ModeleGenPassword
{ {
var $id; var $id;

View File

@ -22,18 +22,19 @@
/** /**
* \file htdocs/lib/ldap.class.php * \file htdocs/lib/ldap.class.php
* \brief Classe de gestion d'annuaire LDAP * \brief File of class to manage LDAP features
* \author Rodolphe Quiedeville
* \author Benoit Mortier
* \author Regis Houssin
* \author Laurent Destailleur
* \version $Id$ * \version $Id$
*/ */
/**
* \class Ldap
* \brief Class to manage LDAP features
*/
class Ldap class Ldap
{ {
/** /**
* Tableau des serveurs (IP addresses ou nom d'h<EFBFBD>tes) * Tableau des serveurs (IP addresses ou nom d'hotes)
*/ */
var $server=array(); var $server=array();
/** /**

View File

@ -20,7 +20,7 @@
/** /**
* \file htdocs/public/members/new.php * \file htdocs/public/members/new.php
* \ingroup adherent * \ingroup member
* \brief Example of form to add a new member * \brief Example of form to add a new member
* \version $Id$ * \version $Id$
*/ */

View File

@ -20,7 +20,7 @@
/** /**
* \file htdocs/public/members/public_card.php * \file htdocs/public/members/public_card.php
* \ingroup adherent * \ingroup member
* \brief File to show a public card of a member * \brief File to show a public card of a member
* \version $Id$ * \version $Id$
*/ */

View File

@ -20,7 +20,7 @@
/** /**
* \file htdocs/public/members/priv_liste.php * \file htdocs/public/members/priv_liste.php
* \ingroup adherent * \ingroup member
* \brief File sample to list members * \brief File sample to list members
* \version $Id$ * \version $Id$
*/ */