From c8190858f8cc2cfb05357b48f4cbc91d0982a103 Mon Sep 17 00:00:00 2001 From: Regis Houssin Date: Mon, 9 Nov 2009 20:20:23 +0000 Subject: [PATCH] Fix: doxygen --- htdocs/admin/ldap.php | 12 +++--- htdocs/admin/triggers.php | 16 +++---- htdocs/compta/bank/account.class.php | 62 ++++++++++++++-------------- 3 files changed, 46 insertions(+), 44 deletions(-) diff --git a/htdocs/admin/ldap.php b/htdocs/admin/ldap.php index d824a3beee0..60db68c9aeb 100644 --- a/htdocs/admin/ldap.php +++ b/htdocs/admin/ldap.php @@ -21,11 +21,11 @@ */ /** - \file htdocs/admin/ldap.php - \ingroup ldap - \brief Page d'administration/configuration du module Ldap - \version $Id$ -*/ + * \file htdocs/admin/ldap.php + * \ingroup ldap + * \brief Page d'administration/configuration du module Ldap + * \version $Id$ + */ require("./pre.inc.php"); require_once(DOL_DOCUMENT_ROOT."/lib/admin.lib.php"); @@ -255,7 +255,7 @@ if (function_exists("ldap_connect")) if ($_GET["action"] == 'test') { - $ldap = new Ldap(); // Les parametres sont pass�s et r�cup�r�s via $conf + $ldap = new Ldap(); // Les parametres sont passes et recuperes via $conf $result = $ldap->connect_bind(); if ($result) diff --git a/htdocs/admin/triggers.php b/htdocs/admin/triggers.php index a422ff4b36b..7d114a68965 100644 --- a/htdocs/admin/triggers.php +++ b/htdocs/admin/triggers.php @@ -47,9 +47,10 @@ if ($_GET["action"] == 'reset' && $user->admin) } -/** \brief Active un module - \param value Nom du module a activer -*/ +/** + * \brief Active un module + * \param value Nom du module a activer + */ function Activate($value) { global $db, $modules; @@ -65,7 +66,7 @@ function Activate($value) $objMod->init(); } - // Activation des modules dont le module d�pend + // Activation des modules dont le module depend for ($i = 0; $i < sizeof($objMod->depends); $i++) { Activate($objMod->depends[$i]); @@ -74,9 +75,10 @@ function Activate($value) } -/** \brief D�sactive un module - \param value Nom du module a d�sactiver -*/ +/** + * \brief Desactive un module + * \param value Nom du module a desactiver + */ function UnActivate($value) { global $db, $modules; diff --git a/htdocs/compta/bank/account.class.php b/htdocs/compta/bank/account.class.php index f86444d1a85..887f60c95ff 100644 --- a/htdocs/compta/bank/account.class.php +++ b/htdocs/compta/bank/account.class.php @@ -98,13 +98,13 @@ class Account extends CommonObject /** - * Add a link between bank line record and its source - * @param line_id Id ecriture bancaire - * @param url_id Id parametre url - * @param url Url - * @param label Link label - * @param type Type of link ('payment', 'company', 'member', ...) - * @return int <0 if KO, id line if OK + * \brief Add a link between bank line record and its source + * \param line_id Id ecriture bancaire + * \param url_id Id parametre url + * \param url Url + * \param label Link label + * \param type Type of link ('payment', 'company', 'member', ...) + * \return int <0 if KO, id line if OK */ function add_url_line($line_id, $url_id, $url, $label, $type) { @@ -137,8 +137,8 @@ class Account extends CommonObject /** * \brief Renvoi tableau des liens - * \param line_id Id ligne �criture - * \retuen array Tableau des liens + * \param line_id Id ligne ecriture + * \return array Tableau des liens */ function get_url($line_id) { @@ -174,18 +174,18 @@ class Account extends CommonObject } /** - \brief Ajoute une entree dans la table ".MAIN_DB_PREFIX."bank - \param $date Date operation - \param $oper 1,2,3,4... or TYP,VIR,PRE,LIQ,VAD,CB,CHQ... - \param $label Descripton - \param $amount Montant - \param $num_chq Numero cheque ou virement - \param $categorie Categorie optionnelle - \param $user User that create - \param $emetteur Nom emetteur - \param $banque Banque emettrice - \return int Rowid of added entry, <0 si erreur - */ + * \brief Ajoute une entree dans la table ".MAIN_DB_PREFIX."bank + * \param $date Date operation + * \param $oper 1,2,3,4... or TYP,VIR,PRE,LIQ,VAD,CB,CHQ... + * \param $label Descripton + * \param $amount Montant + * \param $num_chq Numero cheque ou virement + * \param $categorie Categorie optionnelle + * \param $user User that create + * \param $emetteur Nom emetteur + * \param $banque Banque emettrice + * \return int Rowid of added entry, <0 si erreur + */ function addline($date, $oper, $label, $amount, $num_chq='', $categorie='', $user, $emetteur='',$banque='') { // Clean parameters @@ -448,7 +448,7 @@ class Account extends CommonObject } - /* + /** * \brief Update BBAN (RIB) account fields * \param user Object user making update * \return int <0 if KO, >0 if OK @@ -499,7 +499,7 @@ class Account extends CommonObject } - /* + /** * \brief Charge un compte en memoire depuis la base * \param id Id du compte a recuperer * \param ref Ref du compte a recuperer @@ -571,7 +571,7 @@ class Account extends CommonObject } - /* + /** * \brief Efface le compte */ function delete() @@ -648,7 +648,7 @@ class Account extends CommonObject } - /* + /** * \brief Renvoi si un compte peut etre supprimer ou non (sans mouvements) * \return boolean vrai si peut etre supprime, faux sinon */ @@ -672,8 +672,8 @@ class Account extends CommonObject } - /* - * + /** + * \brief return error */ function error() { @@ -705,8 +705,8 @@ class Account extends CommonObject } } - /* - * + /** + * \brief */ function datev_next($rowid) { @@ -730,8 +730,8 @@ class Account extends CommonObject } } - /* - * + /** + * \brief */ function datev_previous($rowid) {