Doc: Documentation doxygen

This commit is contained in:
Laurent Destailleur 2005-09-02 21:34:22 +00:00
parent 80b84b5a06
commit dfb930cfb2
6 changed files with 32 additions and 23 deletions

View File

@ -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)
{

View File

@ -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)
{

View File

@ -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
*/

View File

@ -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
*/

View File

@ -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;

View File

@ -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;
}