Wavyzz/dolibarr-fork
2
0
Fork 0
forked from Wavyzz/dolibarr
Code Pull Requests Activity

Doc: Maj doc doxygen

Browse Source
This commit is contained in:
Laurent Destailleur
2008-01-20 19:24:05 +00:00
parent 077c5b2f3e
commit 6e3aeee8c7
30 changed files with 60 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
htdocs/admin/editeur.php
View File

@@ -20,7 +20,7 @@
*/ */
/** /**
\file htdocs/admin/adherent.php \file htdocs/admin/editeur.php
\ingroup editeur \ingroup editeur
\brief Page d'administration/configuration du module Editeur \brief Page d'administration/configuration du module Editeur
\version $Revision$ \version $Revision$

2
htdocs/admin/import/index.php
View File

@@ -20,7 +20,7 @@
*/ */
/** /**
\file htdocs/imports/index.php \file htdocs/admin/imports/index.php
\ingroup core \ingroup core
\brief Page accueil de la zone import \brief Page accueil de la zone import
\version $Revision$ \version $Revision$

2
htdocs/boutique/critiques/index.php
View File

@@ -21,7 +21,7 @@
*/ */
/** /**
\file htdocs/boutique/critiques/fiche.php \file htdocs/boutique/critiques/index.php
\ingroup boutique \ingroup boutique
\brief Page gestion critiques OSCommerce \brief Page gestion critiques OSCommerce
\version $Revision$ \version $Revision$

2
htdocs/boutique/promotion/index.php
View File

@@ -21,7 +21,7 @@
*/ */
/** /**
\file htdocs/boutique/promotions/fiche.php \file htdocs/boutique/promotions/index.php
\ingroup boutique \ingroup boutique
\brief Page gestion promotions OSCommerce \brief Page gestion promotions OSCommerce
\version $Revision$ \version $Revision$

11
htdocs/compta/paiement/cheque/remisecheque.class.php
View File

@@ -20,7 +20,7 @@
*/ */
/** /**
\file htdocs/compta/paiement/cheque/resimecheque.class.php \file htdocs/compta/paiement/cheque/remisecheque.class.php
\ingroup compta \ingroup compta
\brief Fichier de la classe des bordereau de remise de cheque \brief Fichier de la classe des bordereau de remise de cheque
\version $Revision$ \version $Revision$
@@ -230,9 +230,8 @@ class RemiseCheque extends CommonObject
/** /**
\brief Supprime la remise en base \brief Supprime la remise en base
\param user utilisateur qui effectue l'operation \param user utilisateur qui effectue l'operation
\param account_id Compte bancaire concerne
*/ */
function Delete() function Delete($user='')
{ {
$this->errno = 0; $this->errno = 0;
$this->db->begin(); $this->db->begin();
@@ -277,10 +276,10 @@ class RemiseCheque extends CommonObject
return $this->errno; return $this->errno;
} }
/** /**
\brief Supprime la remise en base \brief Supprime la remise en base
\param user utilisateur qui effectue l'operation \param user Utilisateur qui effectue l'operation
\param account_id Compte bancaire concerne
*/ */
function Validate($user) function Validate($user)
{ {
@@ -389,7 +388,7 @@ class RemiseCheque extends CommonObject
\brief G<>n<EFBFBD>re le fichier PDF \brief G<>n<EFBFBD>re le fichier PDF
\param model Nom du modele \param model Nom du modele
\return int <0 si KO, 0 si OK \return int <0 si KO, 0 si OK
\todo Finir la gestion multi mod<6F>le \TODO Finir la gestion multi mod<6F>le
*/ */
function GeneratePdf($model='Blochet') function GeneratePdf($model='Blochet')
{ {

2
htdocs/docs/document.class.php
View File

@@ -21,7 +21,7 @@
*/ */
/** /**
\file docs/class/courrier-droit-editeur.class.php \file htdocs/docs/document.class.php
\ingroup editeurs \ingroup editeurs
\brief Classe de generation des courriers pour les editeurs \brief Classe de generation des courriers pour les editeurs
*/ */

1
htdocs/includes/menus/barre_left/auguria_backoffice.php
View File

@@ -16,7 +16,6 @@
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
* *
* $Id$ * $Id$
* $Source$
*/ */
/** /**

3
htdocs/includes/menus/barre_left/auguria_frontoffice.php
View File

@@ -16,11 +16,10 @@
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
* *
* $Id$ * $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 \brief Gestionnaire du menu du gauche Auguria
\version $Revision$ \version $Revision$

4
htdocs/includes/menus/barre_left/rodolphe.php
View File

@@ -16,11 +16,9 @@
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
* *
* $Id$ * $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 \brief Gestionnaire par d<>faut du menu de gauche
\version $Revision$ \version $Revision$

2
htdocs/includes/menus/barre_top/auguria_backoffice.php
View File

@@ -20,7 +20,7 @@
/** /**
\file htdocs/includes/menus/barre_top/auguria_backoffice.php \file htdocs/includes/menus/barre_top/auguria_backoffice.php
\brief Gestionnaire nomm<EFBFBD> Auguria du menu du haut \brief Gestionnaire nomme Auguria du menu du haut
\version $Revision$ \version $Revision$
\remarks La construction d'un gestionnaire pour le menu du haut est simple: \remarks La construction d'un gestionnaire pour le menu du haut est simple:

2
htdocs/includes/menus/barre_top/auguria_frontoffice.php
View File

@@ -20,7 +20,7 @@
/** /**
\file htdocs/includes/menus/barre_top/auguria_backoffice.php \file htdocs/includes/menus/barre_top/auguria_backoffice.php
\brief Gestionnaire nomm<EFBFBD> Auguria du menu du haut \brief Gestionnaire nomme Auguria du menu du haut
\version $Revision$ \version $Revision$
\remarks La construction d'un gestionnaire pour le menu du haut est simple: \remarks La construction d'un gestionnaire pour le menu du haut est simple:

2
htdocs/includes/menus/barre_top/rodolphe.php
View File

@@ -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 \brief Gestionnaire par d<>faut du menu du haut
\remarks La construction d'un gestionnaire pour le menu du haut est simple: \remarks La construction d'un gestionnaire pour le menu du haut est simple:

5
htdocs/includes/modules/facture/pdf_crabe.modules.php
View File

@@ -100,8 +100,9 @@ class pdf_crabe extends ModelePDFFactures
/** /**
* \brief Fonction générant la facture sur le disque * \brief Fonction générant la facture sur le disque
* \param fac Objet facture à générer (ou id si ancienne methode) * \param fac Objet facture à générer (ou id si ancienne methode)
* \return int 1=ok, 0=ko * \param outputlangs Lang object for output language
* \return int 1=ok, 0=ko
*/ */
function write_file($fac,$outputlangs='') function write_file($fac,$outputlangs='')
{ {

5
htdocs/includes/modules/facture/pdf_huitre.modules.php
View File

@@ -80,8 +80,9 @@ class pdf_huitre extends ModelePDFFactures
/** /**
* \brief Fonction g<>n<EFBFBD>rant la facture sur le disque * \brief Fonction g<>n<EFBFBD>rant la facture sur le disque
* \param fac Objet facture <20> g<>n<EFBFBD>rer (ou id si ancienne methode) * \param fac Objet facture <20> g<>n<EFBFBD>rer (ou id si ancienne methode)
* \return int 1=ok, 0=ko * \param outputlangs Lang object for output language
* \return int 1=ok, 0=ko
*/ */
function write_file($fac,$outputlangs='') function write_file($fac,$outputlangs='')
{ {

5
htdocs/includes/modules/facture/pdf_oursin.modules.php
View File

@@ -84,8 +84,9 @@ class pdf_oursin extends ModelePDFFactures
/** /**
* \brief Fonction g<>n<EFBFBD>rant la facture sur le disque * \brief Fonction g<>n<EFBFBD>rant la facture sur le disque
* \param fac Objet facture <20> g<>n<EFBFBD>rer (ou id si ancienne methode) * \param fac Objet facture <20> g<>n<EFBFBD>rer (ou id si ancienne methode)
* \return int 1=ok, 0=ko * \param outputlangs Lang object for output language
* \return int 1=ok, 0=ko
*/ */
function write_file($fac,$outputlangs='') function write_file($fac,$outputlangs='')
{ {

4
htdocs/includes/modules/modAgenda.class.php
View File

@@ -23,8 +23,8 @@
*/ */
/** /**
\defgroup adherent Module adherents \defgroup agenda Module agenda
\brief Module pour gerer les adherents d'une association \brief Module pour gerer l'agenda et actions
*/ */
/** /**

5
htdocs/includes/modules/propale/pdf_propale_azur.modules.php
View File

@@ -99,8 +99,9 @@ class pdf_propale_azur extends ModelePDFPropales
/** /**
\brief Fonction g<>n<EFBFBD>rant la propale sur le disque \brief Fonction g<>n<EFBFBD>rant la propale sur le disque
\param propale Objet propal <20> g<>n<EFBFBD>rer (ou id si ancienne methode) \param propale Objet propal <20> g<>n<EFBFBD>rer (ou id si ancienne methode)
\return int 1=ok, 0=ko \param outputlangs Lang object for output language
\return int 1=ok, 0=ko
*/ */
function write_file($propale,$outputlangs='') function write_file($propale,$outputlangs='')
{ {

6
htdocs/includes/modules/propale/pdf_propale_bleu.modules.php
View File

@@ -18,7 +18,6 @@
* or see http://www.gnu.org/ * or see http://www.gnu.org/
* *
* $Id$ * $Id$
* $Source$
*/ */
/** \file htdocs/includes/modules/propale/pdf_propale_bleu.modules.php /** \file htdocs/includes/modules/propale/pdf_propale_bleu.modules.php
@@ -74,8 +73,9 @@ class pdf_propale_bleu extends ModelePDFPropales
/** /**
\brief Fonction g<>n<EFBFBD>rant la propale sur le disque \brief Fonction g<>n<EFBFBD>rant la propale sur le disque
\param propale Objet propal \param propale Objet propal
\return int 1=ok, 0=ko \param outputlangs Lang object for output language
\return int 1=ok, 0=ko
*/ */
function write_file($propale,$outputlangs='') function write_file($propale,$outputlangs='')
{ {

6
htdocs/includes/modules/propale/pdf_propale_jaune.modules.php
View File

@@ -18,7 +18,6 @@
* or see http://www.gnu.org/ * or see http://www.gnu.org/
* *
* $Id$ * $Id$
* $Source$
*/ */
/** \file htdocs/includes/modules/propale/pdf_propale_jaune.modules.php /** \file htdocs/includes/modules/propale/pdf_propale_jaune.modules.php
@@ -75,8 +74,9 @@ class pdf_propale_jaune extends ModelePDFPropales
/** /**
\brief Fonction g<>n<EFBFBD>rant la propale sur le disque \brief Fonction g<>n<EFBFBD>rant la propale sur le disque
\param propale Objet propal \param propale Objet propal
\return int 1=ok, 0=ko \param outputlangs Lang object for output language
\return int 1=ok, 0=ko
*/ */
function write_file($propale,$outputlangs='') function write_file($propale,$outputlangs='')
{ {

6
htdocs/includes/modules/propale/pdf_propale_rouge.modules.php
View File

@@ -18,7 +18,6 @@
* or see http://www.gnu.org/ * or see http://www.gnu.org/
* *
* $Id$ * $Id$
* $Source$
*/ */
/** /**
@@ -78,8 +77,9 @@ class pdf_propale_rouge extends ModelePDFPropales
/** /**
\brief Fonction g<>n<EFBFBD>rant la propale sur le disque \brief Fonction g<>n<EFBFBD>rant la propale sur le disque
\param propale Objet propal \param propale Objet propal
\return int 1=ok, 0=ko \param outputlangs Lang object for output language
\return int 1=ok, 0=ko
*/ */
function write_file($propale,$outputlangs='') function write_file($propale,$outputlangs='')
{ {

6
htdocs/includes/modules/propale/pdf_propale_vert.modules.php
View File

@@ -19,7 +19,6 @@
* or see http://www.gnu.org/ * or see http://www.gnu.org/
* *
* $Id$ * $Id$
* $Source$
*/ */
/** \file htdocs/includes/modules/propale/pdf_propale_vert.modules.php /** \file htdocs/includes/modules/propale/pdf_propale_vert.modules.php
@@ -76,8 +75,9 @@ class pdf_propale_vert extends ModelePDFPropales
/** /**
\brief Fonction g<>n<EFBFBD>rant la propale sur le disque \brief Fonction g<>n<EFBFBD>rant la propale sur le disque
\param propale Objet propal \param propale Objet propal
\return int 1=ok, 0=ko \param outputlangs Lang object for output language
\return int 1=ok, 0=ko
*/ */
function write_file($propale,$outputlangs='') function write_file($propale,$outputlangs='')
{ {

10
htdocs/includes/vcard/vcard.class.php
View File

@@ -197,11 +197,11 @@ class vCard {
$this->properties["LABEL;$type;ENCODING=QUOTED-PRINTABLE"] = quoted_printable_encode($label); $this->properties["LABEL;$type;ENCODING=QUOTED-PRINTABLE"] = quoted_printable_encode($label);
} }
/** /**
\brief mise en forme de l'email \brief Mise en forme de l'email
\param address \param address EMail
*/ \param type Vcard type
*/
function setEmail($address,$type="internet,pref") { function setEmail($address,$type="internet,pref") {
$this->properties["EMAIL;TYPE=".$type] = $address; $this->properties["EMAIL;TYPE=".$type] = $address;
} }

2
htdocs/lib/databases/mssql.lib.php
View File

@@ -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 \brief Fichier de la classe permettant de g<>rer une base mssql
*/ */

2
htdocs/lib/databases/mysql.lib.php
View File

@@ -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 \brief Fichier de la classe permettant de g<>rer une base mysql
*/ */

2
htdocs/lib/databases/mysqli.lib.php
View File

@@ -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 \brief Fichier de la classe permettant de g<>rer une base mysql
*/ */

2
htdocs/lib/databases/pgsql.lib.php
View File

@@ -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<EFBFBD>r une base pgsql \brief Fichier de la classe permettant de g<>r<EFBFBD>r une base pgsql
*/ */

11
htdocs/propal.class.php
View File

@@ -126,7 +126,6 @@ class Propal extends CommonObject
* \param idproduct Id du produit <20> ajouter * \param idproduct Id du produit <20> ajouter
* \param qty Quantit<69> * \param qty Quantit<69>
* \param remise_percent Remise relative effectu<74>e sur le produit * \param remise_percent Remise relative effectu<74>e sur le produit
* \return void
* \remarks $this->client doit etre charg<72> * \remarks $this->client doit etre charg<72>
* \TODO Remplacer les appels a cette fonction par generation objet Ligne * \TODO Remplacer les appels a cette fonction par generation objet Ligne
* ins<6E>r<EFBFBD> dans tableau $this->products * ins<6E>r<EFBFBD> dans tableau $this->products
@@ -369,11 +368,11 @@ class Propal extends CommonObject
/** /**
* \brief Mise <20> jour d'une ligne de produit * \brief Mise <20> 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 pu Prix unitaire (HT ou TTC selon price_base_type)
* \param qty Quantit<69> * \param qty Quantit<69>
* \param remise_percent Remise effectu<74>e sur le produit * \param remise_percent Remise effectu<74>e sur le produit
* \param tva_tx Taux de TVA * \param txtva Taux de TVA
* \param desc Description * \param desc Description
* \param price_base_type HT ou TTC * \param price_base_type HT ou TTC
* \return int 0 en cas de succ<63>s * \return int 0 en cas de succ<63>s
@@ -1725,8 +1724,8 @@ class Propal extends CommonObject
/** /**
* \brief Change le mode de r<>glement * \brief Change le mode de r<>glement
* \param mode Id du nouveau mode * \param mode_reglement Id du nouveau mode
* \return int >0 si ok, <0 si ko * \return int >0 si ok, <0 si ko
*/ */
function mode_reglement($mode_reglement_id) function mode_reglement($mode_reglement_id)
{ {
@@ -2212,7 +2211,7 @@ class Propal extends CommonObject
\brief Renvoie nom clicable (avec eventuellement le picto) \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 withpicto 0=Pas de picto, 1=Inclut le picto dans le lien, 2=Picto seul
\param option Sur quoi pointe le lien \param option Sur quoi pointe le lien
\param get_param Parametres ajout<EFBFBD> <20> l'url \param get_params Parametres added to url
\return string Chaine avec URL \return string Chaine avec URL
*/ */
function getNomUrl($withpicto=0,$option='', $get_params='') function getNomUrl($withpicto=0,$option='', $get_params='')

5
htdocs/translate.class.php
View File

@@ -263,8 +263,9 @@ class Translate {
* Les param<61>tres de cette m<>thode peuvent contenir de balises HTML. * Les param<61>tres de cette m<>thode peuvent contenir de balises HTML.
* \param key cl<63> de chaine a traduire * \param key cl<63> de chaine a traduire
* \param param1 chaine de param1 * \param param1 chaine de param1
* \param param2 chaine de param1 * \param param2 chaine de param2
* \param param3 chaine de param1 * \param param3 chaine de param3
* \param param4 chaine de param4
* \param maxsize taille max * \param maxsize taille max
* \return string chaine traduite et cod<6F> en HTML * \return string chaine traduite et cod<6F> en HTML
*/ */

2
htdocs/user.class.php
View File

@@ -478,7 +478,7 @@ class User extends CommonObject
/** /**
\brief Charge dans l'objet user, la liste des permissions auxquelles l'utilisateur a droit \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='') function getrights($moduletag='')
{ {

2
htdocs/webcal/webcal.class.php
View File

@@ -181,7 +181,7 @@ class Webcal {
\param type 'event' or 'journal' \param type 'event' or 'journal'
\param cachedelay Do not rebuild file if date older than cachedelay seconds \param cachedelay Do not rebuild file if date older than cachedelay seconds
\param filename Force filename \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 \return int <0 if error, nb of events in new file if ok
*/ */
function build_calfile($format,$type,$cachedelay,$filename,$filters) function build_calfile($format,$type,$cachedelay,$filename,$filters)