From dfb930cfb2b2d4b385beffe077a113a6b51974a1 Mon Sep 17 00:00:00 2001
From: Laurent Destailleur <eldy@users.sourceforge.net>
Date: Fri, 2 Sep 2005 21:34:22 +0000
Subject: [PATCH] Doc: Documentation doxygen
---
.../prelevement/rejet-prelevement.class.php | 8 ++-----
htdocs/graph.class.php | 4 ----
htdocs/html.form.class.php | 23 ++++++++++---------
htdocs/propal.class.php | 5 +++-
scripts/mailing-prepare.php | 6 +++++
scripts/mailing-send.php | 9 +++++++-
6 files changed, 32 insertions(+), 23 deletions(-)
diff --git a/htdocs/compta/prelevement/rejet-prelevement.class.php b/htdocs/compta/prelevement/rejet-prelevement.class.php
index 144b4df8525..0d0c80329e9 100644
--- a/htdocs/compta/prelevement/rejet-prelevement.class.php
+++ b/htdocs/compta/prelevement/rejet-prelevement.class.php
@@ -41,9 +41,8 @@ class RejetPrelevement
/**
* \brief Constructeur de la classe
- * \param DB handler acc�s base de donn�es
- * \param soc_idp id societe ("" par defaut)
- * \param facid id facture ("" par defaut)
+ * \param DB Handler acc�s base de donn�es
+ * \param user Utilisateur
*/
function RejetPrelevement($DB, $user)
{
@@ -235,8 +234,6 @@ class RejetPrelevement
/**
* \brief Recup�re la liste des factures concern�es
- * \param rowid id de la facture a r�cup�rer
- * \param societe_id id de societe
*/
function _get_list_factures()
{
@@ -286,7 +283,6 @@ class RejetPrelevement
/**
* \brief Recup�re l'objet prelevement
* \param rowid id de la facture a r�cup�rer
- * \param societe_id id de societe
*/
function fetch($rowid)
{
diff --git a/htdocs/graph.class.php b/htdocs/graph.class.php
index 7e416aff990..e42e9152d37 100644
--- a/htdocs/graph.class.php
+++ b/htdocs/graph.class.php
@@ -45,8 +45,6 @@ class Graph
/**
* \brief G�n�re le fichier graphique sur le disque
* \param file Nom du fichier image
- * \param data Tableau des donn�es
- * \param title Titre de l'image
*/
function draw($file)
{
@@ -60,8 +58,6 @@ class Graph
/**
* \brief Pr�pare l'objet PHPlot
* \param file Nom du fichier image � g�n�rer
- * \param data Tableau des donn�es
- * \param title Titre de l'image
*/
function prepare($file)
{
diff --git a/htdocs/html.form.class.php b/htdocs/html.form.class.php
index cf52709a432..dc862ce0392 100644
--- a/htdocs/html.form.class.php
+++ b/htdocs/html.form.class.php
@@ -572,7 +572,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 +608,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 +1269,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='')
{
@@ -1479,12 +1479,13 @@ class Form
/**
* \brief Affiche la cartouche de la liste des documents d'une propale, facture...
- * \param modulepart propal=propal, facture=facture, ...
- * \param filename Nom fichier
- * \param filedir Repertoire � scanner
- * \param urlsource Url page origine
- * \param genallowed G�n�ration autoris�e
- * \param delallowed Suppression autoris�e
+ * \param modulepart propal=propal, facture=facture, ...
+ * \param filename Nom fichier
+ * \param filedir Repertoire � scanner
+ * \param urlsource Url page origine
+ * \param genallowed G�n�ration autoris�e
+ * \param delallowed Suppression autoris�e
+ * \param modelselected Modele � pr�s�lectionner par d�faut
* \remarks Le fichier de facture d�taill�e est de la forme
* REFFACTURE-XXXXXX-detail.pdf ou XXXXX est une forme diverse
*/
diff --git a/htdocs/propal.class.php b/htdocs/propal.class.php
index d5e496d6393..37c089144af 100644
--- a/htdocs/propal.class.php
+++ b/htdocs/propal.class.php
@@ -68,7 +68,9 @@ class Propal
/**
* \brief Constructeur
- * \param DB Handler d'acc�s base
+ * \param DB Handler d'acc�s base
+ * \param soc_idp Id de la soci�t�
+ * \param propalid Id de la propal
*/
function Propal($DB, $soc_idp="", $propalid=0)
{
@@ -226,6 +228,7 @@ class Propal
* \param subprice Prix unitaire
* \param qty Quantit�
* \param remise_percent Remise effectu�e sur le produit
+ * \param tva_tx Taux de TVA
* \param desc Description
* \return int 0 en cas de succ�s
*/
diff --git a/scripts/mailing-prepare.php b/scripts/mailing-prepare.php
index 3418f60f2b4..97b250ad8c4 100644
--- a/scripts/mailing-prepare.php
+++ b/scripts/mailing-prepare.php
@@ -36,6 +36,12 @@
*/
+/**
+ \file scripts/mailing-prepare.php
+ \ingroup mailing
+ \brief Script pour pr�parer les destinataires d'un mailing
+*/
+
require ("../htdocs/master.inc.php");
$error = 0;
diff --git a/scripts/mailing-send.php b/scripts/mailing-send.php
index 8f90725be29..adc3faa2f3b 100644
--- a/scripts/mailing-send.php
+++ b/scripts/mailing-send.php
@@ -38,6 +38,13 @@
*/
+/**
+ \file scripts/mailing-send.php
+ \ingroup mailing
+ \brief Script d'envoi d'un mailing pr�par� et valid�
+*/
+
+
// Test si mode batch
$sapi_type = php_sapi_name();
if (substr($sapi_type, 0, 3) == 'cgi') {
@@ -45,7 +52,7 @@ if (substr($sapi_type, 0, 3) == 'cgi') {
exit;
}
-if (! $argv[1]) {
+if (! isset($argv[1]) || ! $argv[1]) {
print "Usage: mailing-send.php ID_MAILING\n";
exit;
}
--
GitLab