From af23658e9eab52774942b80ca39108236a840d87 Mon Sep 17 00:00:00 2001
From: Laurent Destailleur <eldy@users.sourceforge.net>
Date: Fri, 2 Sep 2005 21:48:34 +0000
Subject: [PATCH] Doc: Documentation doxygen
---
htdocs/compta/bank/account.class.php | 1 +
htdocs/don.class.php | 10 +++---
htdocs/html.form.class.php | 16 +++-------
htdocs/lib/mysql.lib.php | 48 +++++++++++++++-------------
4 files changed, 36 insertions(+), 39 deletions(-)
diff --git a/htdocs/compta/bank/account.class.php b/htdocs/compta/bank/account.class.php
index 839ace4a4b4..0538c6edca2 100644
--- a/htdocs/compta/bank/account.class.php
+++ b/htdocs/compta/bank/account.class.php
@@ -91,6 +91,7 @@ class Account
* \param line_id Id ecriture bancaire
* \param url_id Id parametre url
* \param url Url
+ * \param label Libell� du lien
* \param type Type de lien (payment, company, member, ...)
* \return int <0 si ko, id line si ok
*/
diff --git a/htdocs/don.class.php b/htdocs/don.class.php
index 6720d2f656c..4d09af3d4d6 100644
--- a/htdocs/don.class.php
+++ b/htdocs/don.class.php
@@ -175,11 +175,11 @@ class Don
}
- /**
- * \brief Cr�ation du don en base
- * \param userid Objet utilisateur qui cr�e le don
- * \return int id don cr�e si ok, <0 si ko
- */
+ /**
+ * \brief Cr�ation du don en base
+ * \param user Objet utilisateur qui cr�e le don
+ * \return int Id don cr�e si ok, <0 si ko
+ */
function create($user)
{
$this->date = $this->db->idate($this->date);
diff --git a/htdocs/html.form.class.php b/htdocs/html.form.class.php
index 4c070dabd88..77b4c82c3a0 100644
--- a/htdocs/html.form.class.php
+++ b/htdocs/html.form.class.php
@@ -491,9 +491,6 @@ class Form
/**
* \brief Charge dans cache la liste des conditions de paiements possibles
- * \param selected Condition de paiement pr�s�lectionn�e
- * \param htmlname Nom de la zone select
- * \param filtretype Pour filtre
*/
function load_cache_conditions_paiements()
{
@@ -529,9 +526,6 @@ class Form
/**
* \brief Charge dans cache la liste des types de paiements possibles
- * \param selected Type de praiement pr�s�lectionn�
- * \param htmlname Nom de la zone select
- * \param filtretype Pour filtre
*/
function load_cache_types_paiements()
{
@@ -572,7 +566,7 @@ class Form
* \brief Retourne la liste des types de paiements possibles
* \param selected Type de praiement pr�s�lectionn�
* \param htmlname Nom de la zone select
- * \param filtretype Pour filtre
+ * \param filtertype Pour filtre
*/
function select_conditions_paiements($selected='',$htmlname='condid',$filtertype=-1)
{
@@ -608,7 +602,7 @@ class Form
* \brief Retourne la liste des types de paiements possibles
* \param selected Type de praiement pr�s�lectionn�
* \param htmlname Nom de la zone select
- * \param filtretype Pour filtre
+ * \param filtertype Pour filtre
* \param format 0=id+libelle, 1=code+code
*/
function select_types_paiements($selected='',$htmlname='paiementtype',$filtertype='',$format=0)
@@ -1269,9 +1263,9 @@ class Form
/**
* \brief Affiche liste d�roulante depuis requete SQL
- * \param Nom de la zone select
- * \param Requete sql
- * \param Id pr�s�lectionn�
+ * \param name Nom de la zone select
+ * \param sql Requete sql
+ * \param id Id pr�s�lectionn�
*/
function select($name, $sql, $id='')
{
diff --git a/htdocs/lib/mysql.lib.php b/htdocs/lib/mysql.lib.php
index f66ab66a8fb..ad4c0ad9d39 100644
--- a/htdocs/lib/mysql.lib.php
+++ b/htdocs/lib/mysql.lib.php
@@ -559,33 +559,35 @@ class DoliDb
/**
\brief Renvoie toutes les donn�es comme un tableau.
- \param sql requete sql
- \return array
+ \param sql Requete sql
+ \param data Tableau de donn�es pour retour
+ \return int >0 si ok, <0 si ko
*/
-
function fetch_all_rows($sql, &$datas)
{
- $datas = array();
-
- $resql = $this->query($sql);
- if ($resql)
- {
- $i = 0;
- $num = $this->num_rows($resql);
-
- while ($i < $num)
- {
- $row = $this->fetch_row($resql);
- array_push($datas, $row[0]);
- $i++;
- }
- }
- else
- {
- print $this->error();
- }
- return $result;
+ $datas = array();
+
+ $resql = $this->query($sql);
+ if ($resql)
+ {
+ $i = 0;
+ $num = $this->num_rows($resql);
+
+ while ($i < $num)
+ {
+ $row = $this->fetch_row($resql);
+ array_push($datas, $row[0]);
+ $i++;
+ }
+ }
+ else
+ {
+ print $this->error();
+ return -1;
+ }
+ return 1;
}
+
}
?>
--
GitLab