Doc: Documentation doxygen
This commit is contained in:
Laurent Destailleur
parent
ba178544cc
commit
c046b01938
@ -49,7 +49,7 @@ class PaiementCharge {
|
||||
|
||||
/**
|
||||
* \brief Creation d'un paiement de charge sociale
|
||||
* \user user Utilisateur qui crée le paiement
|
||||
* \param user Utilisateur qui crée le paiement
|
||||
* \return int <0 si erreur, >0 si ok
|
||||
*/
|
||||
function create($user) {
|
||||
@ -101,8 +101,9 @@ class PaiementCharge {
|
||||
}
|
||||
|
||||
/**
|
||||
* \brief Mise a jour du lien entre le paiement de charge et la ligne dans llx_bank générée
|
||||
*
|
||||
* \brief Mise a jour du lien entre le paiement de charge et la ligne dans llx_bank générée
|
||||
* \param id_bank Id de la banque
|
||||
* \return int 1 ou 0
|
||||
*/
|
||||
function update_fk_bank($id_bank) {
|
||||
$sql = "UPDATE llx_paiementcharge set fk_bank = ".$id_bank." where rowid = ".$this->id;
|
||||
|
||||
@ -183,8 +183,8 @@ class Form
|
||||
|
||||
/**
|
||||
* \brief Retourne la liste déroulante des pays actifs, dans la langue de l'utilisateur
|
||||
* \param selected code pays pré-sélectionné
|
||||
* \param htmlname nom de la liste deroulante
|
||||
* \param selected Code pays pré-sélectionné
|
||||
* \param htmlname Nom de la liste deroulante
|
||||
* \todo trier liste sur noms après traduction plutot que avant
|
||||
*/
|
||||
|
||||
@ -268,8 +268,9 @@ class Form
|
||||
|
||||
|
||||
/**
|
||||
* \brief Retourne la liste des types de comptes financiers
|
||||
* \param
|
||||
* \brief Retourne la liste des types de comptes financiers
|
||||
* \param selected Type pré-sélectionné
|
||||
* \param htmlname Nom champ formulaire
|
||||
*/
|
||||
|
||||
function select_type_comptes_financiers($selected=1,$htmlname='type')
|
||||
@ -303,9 +304,9 @@ class Form
|
||||
|
||||
/**
|
||||
* \brief Retourne la liste déroulante des sociétés
|
||||
* \param selected societe présélectionnée
|
||||
* \param htmlname nom champ formulaire
|
||||
* \param filter criteres optionnels de filtre
|
||||
* \param selected Societe présélectionnée
|
||||
* \param htmlname Nom champ formulaire
|
||||
* \param filter Criteres optionnels de filtre
|
||||
*/
|
||||
function select_societes($selected='',$htmlname='soc_id',$filter)
|
||||
{
|
||||
@ -346,8 +347,10 @@ class Form
|
||||
|
||||
|
||||
/**
|
||||
* \brief Retourne la liste déroulante des contacts d'une société donnée
|
||||
*
|
||||
* \brief Retourne la liste déroulante des contacts d'une société donnée
|
||||
* \param socid Id de la société
|
||||
* \param selected Id contact pré-sélectionné
|
||||
* \param htmlname Nom champ formulaire
|
||||
*/
|
||||
function select_contacts($socid,$selected='',$htmlname='contactid')
|
||||
{
|
||||
@ -616,7 +619,7 @@ class Form
|
||||
/**
|
||||
* \brief Retourne la liste déroulante des formes juridiques tous pays confondus ou pour un pays donné.
|
||||
* \remarks Dans le cas d'une liste tous pays confondu, on affiche une rupture sur le pays
|
||||
* \param selected code forme juridique a présélectionné
|
||||
* \param selected Code forme juridique a présélectionné
|
||||
* \param pays_code 0=liste tous pays confondus, sinon code du pays à afficher
|
||||
*/
|
||||
|
||||
@ -1151,9 +1154,9 @@ class Form
|
||||
|
||||
/**
|
||||
* \brief Selection de oui/non en chaine (renvoie yes/no)
|
||||
* \param name nom du select
|
||||
* \param value valeur présélectionnée
|
||||
* \param option 0 retourne yes/no, 1 retourne 1/0
|
||||
* \param name Nom du select
|
||||
* \param value Valeur présélectionnée
|
||||
* \param option 0 retourne yes/no, 1 retourne 1/0
|
||||
*/
|
||||
function selectyesno($name,$value='',$option=0)
|
||||
{
|
||||
@ -1183,8 +1186,8 @@ class Form
|
||||
|
||||
/**
|
||||
* \brief Selection de oui/non en chiffre (renvoie 1/0)
|
||||
* \param name nom du select
|
||||
* \param value valeur présélectionnée
|
||||
* \param name Nom du select
|
||||
* \param value Valeur présélectionnée
|
||||
*/
|
||||
function selectyesnonum($name,$value='')
|
||||
{
|
||||
|
||||
@ -39,8 +39,8 @@ class pdf_propale_azur extends ModelePDFPropales
|
||||
{
|
||||
|
||||
/**
|
||||
\brief Constructeur
|
||||
\param db handler accès base de donnée
|
||||
\brief Constructeur
|
||||
\param db Handler accès base de donnée
|
||||
*/
|
||||
function pdf_propale_azur($db=0)
|
||||
{
|
||||
@ -74,8 +74,9 @@ class pdf_propale_azur extends ModelePDFPropales
|
||||
}
|
||||
|
||||
|
||||
/** \brief Renvoi dernière erreur
|
||||
\return string Dernière erreur
|
||||
/**
|
||||
\brief Renvoi dernière erreur
|
||||
\return string Dernière erreur
|
||||
*/
|
||||
function pdferror()
|
||||
{
|
||||
@ -84,8 +85,8 @@ class pdf_propale_azur extends ModelePDFPropales
|
||||
|
||||
/**
|
||||
\brief Fonction générant la propale sur le disque
|
||||
\param facid id de la propale à générer
|
||||
\return int 1=ok, 0=ko
|
||||
\param id Id de la propale à générer
|
||||
\return int 1=ok, 0=ko
|
||||
\remarks Variables utilisées
|
||||
\remarks MAIN_INFO_SOCIETE_NOM
|
||||
\remarks MAIN_INFO_SIRET
|
||||
|
||||
@ -791,9 +791,9 @@ class Propal
|
||||
}
|
||||
|
||||
/**
|
||||
* \brief Renvoie un tableau contenant les numéros de commandes associées
|
||||
* \remarks Fonction plus light que associated_orders
|
||||
* \seealso associated_orders
|
||||
* \brief Renvoie un tableau contenant les numéros de commandes associées
|
||||
* \remarks Fonction plus light que associated_orders
|
||||
* \sa associated_orders
|
||||
*/
|
||||
function commande_liste_array ()
|
||||
{
|
||||
@ -827,7 +827,7 @@ class Propal
|
||||
/**
|
||||
* \brief Renvoie un tableau contenant les commandes associées
|
||||
* \remarks Fonction plus lourde que commande_liste_array
|
||||
* \seealso commande_liste_array
|
||||
* \sa commande_liste_array
|
||||
*/
|
||||
function associated_orders ()
|
||||
{
|
||||
|
||||
Loading…
Reference in New Issue
Block a user