2
0
forked from Wavyzz/dolibarr

Doc: Documentation doxygen

This commit is contained in:
Laurent Destailleur
2005-07-10 20:22:49 +00:00
parent c4a906ed4f
commit 4e59ea4480
4 changed files with 29 additions and 27 deletions

View File

@@ -19,7 +19,7 @@
* $Source$ * $Source$
*/ */
/*! /**
\file htdocs/compta/export/modules/compta.export.class.php \file htdocs/compta/export/modules/compta.export.class.php
\ingroup compta \ingroup compta
\brief Fichier de la classe d'export compta \brief Fichier de la classe d'export compta
@@ -27,7 +27,7 @@
*/ */
/*! /**
\class ComptaExport \class ComptaExport
\brief Classe permettant les exports comptables \brief Classe permettant les exports comptables
*/ */
@@ -35,13 +35,12 @@
class ComptaExport class ComptaExport
{ {
/*! /**
\brief Createur Classe \brief Constructeur de la class
\param DB object de base de donn<6E>es \param DB Object de base de donn<6E>es
\param USER object utilisateur \param USER Object utilisateur
\param class nom de la classe utilis<69>e pour formater les rapports \param classe Nom de la classe utilis<69>e pour formater les rapports
*/ */
function ComptaExport ($DB, $USER, $classe) function ComptaExport ($DB, $USER, $classe)
{ {
$this->db = $DB; $this->db = $DB;
@@ -50,10 +49,11 @@ class ComptaExport
$this->error_message = ''; $this->error_message = '';
} }
/*!
\brief Lecture des factures dans la base
*/
/**
\brief Lecture des factures dans la base
\param id Id ligne
*/
function ReadLines($id=0) function ReadLines($id=0)
{ {
dolibarr_syslog("ComptaExport::ReadLines id=".$id); dolibarr_syslog("ComptaExport::ReadLines id=".$id);
@@ -123,8 +123,9 @@ class ComptaExport
return $error; return $error;
} }
/*! /**
\brief Lecture des paiements dans la base \brief Lecture des paiements dans la base
\param id Id ligne
*/ */
function ReadLinesPayment($id=0) function ReadLinesPayment($id=0)
@@ -196,7 +197,7 @@ class ComptaExport
return $error; return $error;
} }
/*! /**
\brief Cr<43><72> le fichier d'export \brief Cr<43><72> le fichier d'export
*/ */

View File

@@ -532,7 +532,7 @@ class Form
* \param selected Type de praiement pr<70>s<EFBFBD>lectionn<6E> * \param selected Type de praiement pr<70>s<EFBFBD>lectionn<6E>
* \param htmlname Nom de la zone select * \param htmlname Nom de la zone select
* \param statut Statut des comptes recherch<63>s * \param statut Statut des comptes recherch<63>s
* \param filtretype Pour filtre * \param filtre Pour filtre sur la liste
*/ */
function select_comptes($selected='',$htmlname='paiementtype',$statut=0,$filtre='') function select_comptes($selected='',$htmlname='paiementtype',$statut=0,$filtre='')
{ {

View File

@@ -492,7 +492,7 @@ function img_action($alt = "default", $numaction)
/** /**
\brief Affiche logo statut \brief Affiche logo statut
\param num Num<75>ro statut \param num Num<75>ro statut
\param text Texte a afficher sur alt \param alt Texte a afficher sur alt
\return string Retourne tag img \return string Retourne tag img
*/ */
function img_statut($num,$alt = "default") function img_statut($num,$alt = "default")

View File

@@ -76,11 +76,12 @@ class DoliDb
/** /**
\brief Ouverture d'une connection vers le serveur et <20>ventuellement une database. \brief Ouverture d'une connection vers le serveur et <20>ventuellement une database.
\param type type de base de donn<6E>es (mysql ou pgsql) \param type Type de base de donn<6E>es (mysql ou pgsql)
\param host addresse de la base de donn<6E>es \param host Addresse de la base de donn<6E>es
\param user nom de l'utilisateur autoris<69> \param user Nom de l'utilisateur autoris<69>
\param pass mot de passe \param pass Mot de passe
\param name nom de la database \param name Nom de la database
\param newlink ???
\return int 1 en cas de succ<63>s, 0 sinon \return int 1 en cas de succ<63>s, 0 sinon
*/ */
function DoliDb($type='mysql', $host, $user, $pass, $name='', $newlink=0) function DoliDb($type='mysql', $host, $user, $pass, $name='', $newlink=0)