From 7b01e76d2b8f7c3e9c398b64c49297fb5918bfa5 Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Mon, 8 Apr 2019 16:04:15 +0200 Subject: [PATCH] Fix doxygen --- htdocs/comm/mailing/class/mailing.class.php | 2 +- htdocs/commande/class/commande.class.php | 8 ++++---- .../compta/paiement/cheque/class/remisecheque.class.php | 2 +- htdocs/compta/paiement/class/paiement.class.php | 4 ++-- htdocs/contrat/class/contrat.class.php | 6 +++--- htdocs/don/class/paymentdonation.class.php | 2 +- htdocs/expedition/class/expedition.class.php | 2 +- htdocs/livraison/class/livraison.class.php | 4 ++-- htdocs/product/stock/class/api_stockmovements.class.php | 2 +- htdocs/user/class/user.class.php | 8 ++++---- 10 files changed, 20 insertions(+), 20 deletions(-) diff --git a/htdocs/comm/mailing/class/mailing.class.php b/htdocs/comm/mailing/class/mailing.class.php index c94c516d27d..0fd41c9dc02 100644 --- a/htdocs/comm/mailing/class/mailing.class.php +++ b/htdocs/comm/mailing/class/mailing.class.php @@ -668,7 +668,7 @@ class Mailing extends CommonObject * * @param int $statut Id statut * @param int $mode 0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto - * @param strin $desc Desc error + * @param string $desc Desc error * @return string Label */ public static function libStatutDest($statut, $mode = 0, $desc = '') diff --git a/htdocs/commande/class/commande.class.php b/htdocs/commande/class/commande.class.php index b6e4010600c..52a73732d8d 100644 --- a/htdocs/commande/class/commande.class.php +++ b/htdocs/commande/class/commande.class.php @@ -161,7 +161,7 @@ class Commande extends CommonOrder /** * @deprecated - * @see date + * @see $date */ public $date_commande; @@ -1331,7 +1331,7 @@ class Commande extends CommonOrder * @param double $pu_ht_devise Unit price in currency * @return int >0 if OK, <0 if KO * - * @see add_product + * @see add_product() * * Les parametres sont deja cense etre juste et avec valeurs finales a l'appel * de cette methode. Aussi, pour le taux tva, il doit deja avoir ete defini @@ -3905,7 +3905,7 @@ class OrderLine extends CommonOrderLine * Id of parent order * @var int * @deprecated Use fk_commande - * @see fk_commande + * @see $fk_commande */ public $commande_id; @@ -3932,7 +3932,7 @@ class OrderLine extends CommonOrderLine /** * @deprecated - * @see remise_percent, fk_remise_except + * @see $remise_percent, $fk_remise_except */ public $remise; diff --git a/htdocs/compta/paiement/cheque/class/remisecheque.class.php b/htdocs/compta/paiement/cheque/class/remisecheque.class.php index 15b006d2cc6..d9a912ea50b 100644 --- a/htdocs/compta/paiement/cheque/class/remisecheque.class.php +++ b/htdocs/compta/paiement/cheque/class/remisecheque.class.php @@ -773,7 +773,7 @@ class RemiseCheque extends CommonObject * Reopen linked invoices and create a new negative payment. * * @param int $bank_id Id of bank transaction line concerned - * @param date $rejection_date Date to use on the negative payment + * @param integer $rejection_date Date to use on the negative payment * @return int Id of negative payment line created */ public function rejectCheck($bank_id, $rejection_date) diff --git a/htdocs/compta/paiement/class/paiement.class.php b/htdocs/compta/paiement/class/paiement.class.php index 8b4bb12006b..28417a6d4f1 100644 --- a/htdocs/compta/paiement/class/paiement.class.php +++ b/htdocs/compta/paiement/class/paiement.class.php @@ -58,13 +58,13 @@ class Paiement extends CommonObject /** * @deprecated - * @see amount, amounts + * @see $amount, $amounts */ public $total; /** * @deprecated - * @see amount, amounts + * @see $amount, $amounts */ public $montant; diff --git a/htdocs/contrat/class/contrat.class.php b/htdocs/contrat/class/contrat.class.php index 7eaa97061d0..2cd4f472f95 100644 --- a/htdocs/contrat/class/contrat.class.php +++ b/htdocs/contrat/class/contrat.class.php @@ -165,7 +165,7 @@ class Contrat extends CommonObject /** * @deprecated Use fk_project instead - * @see fk_project + * @see $fk_project */ public $fk_projet; @@ -305,7 +305,7 @@ class Contrat extends CommonObject * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers * @param string $comment Comment * @return int <0 if KO, >0 if OK - * @see closeAll + * @see () */ public function activateAll($user, $date_start = '', $notrigger = 0, $comment = '') { @@ -361,7 +361,7 @@ class Contrat extends CommonObject * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers * @param string $comment Comment * @return int <0 if KO, >0 if OK - * @see activateAll + * @see activateAll() */ public function closeAll(User $user, $notrigger = 0, $comment = '') { diff --git a/htdocs/don/class/paymentdonation.class.php b/htdocs/don/class/paymentdonation.class.php index ac35e3f5c44..4ec7c4aa874 100644 --- a/htdocs/don/class/paymentdonation.class.php +++ b/htdocs/don/class/paymentdonation.class.php @@ -79,7 +79,7 @@ class PaymentDonation extends CommonObject /** * @deprecated - * @see amount, amounts + * @see $amount, $amounts */ public $total; diff --git a/htdocs/expedition/class/expedition.class.php b/htdocs/expedition/class/expedition.class.php index ffc43f29cdf..fe7b69e4dc9 100644 --- a/htdocs/expedition/class/expedition.class.php +++ b/htdocs/expedition/class/expedition.class.php @@ -2417,7 +2417,7 @@ class ExpeditionLigne extends CommonObjectLine /** * @deprecated - * @see product_ref + * @see $product_ref */ public $ref; diff --git a/htdocs/livraison/class/livraison.class.php b/htdocs/livraison/class/livraison.class.php index 49904ef44f5..9a84274d0c5 100644 --- a/htdocs/livraison/class/livraison.class.php +++ b/htdocs/livraison/class/livraison.class.php @@ -994,7 +994,7 @@ class Livraison extends CommonObject * Set the planned delivery date * * @param User $user Objet utilisateur qui modifie - * @param timestamp $date_livraison Date de livraison + * @param integer $date_livraison Date de livraison * @return int <0 if KO, >0 if OK */ public function set_date_livraison($user, $date_livraison) @@ -1107,7 +1107,7 @@ class LivraisonLigne extends CommonObjectLine /** * @deprecated - * @see product_ref + * @see $product_ref */ public $ref; /** diff --git a/htdocs/product/stock/class/api_stockmovements.class.php b/htdocs/product/stock/class/api_stockmovements.class.php index 12cf15110fe..7bc4054751e 100644 --- a/htdocs/product/stock/class/api_stockmovements.class.php +++ b/htdocs/product/stock/class/api_stockmovements.class.php @@ -38,7 +38,7 @@ class StockMovements extends DolibarrApi ); /** - * @var MouvmeentStock $stockmovement {@type MouvementStock} + * @var MouvementStock $stockmovement {@type MouvementStock} */ public $stockmovement; diff --git a/htdocs/user/class/user.class.php b/htdocs/user/class/user.class.php index d8f8b0345fe..df338d20653 100644 --- a/htdocs/user/class/user.class.php +++ b/htdocs/user/class/user.class.php @@ -517,7 +517,7 @@ class User extends CommonObject * @param int $entity Entity to use * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers * @return int > 0 if OK, < 0 if KO - * @see clearrights, delrights, getrights + * @see clearrights(), delrights(), getrights() */ public function addrights($rid, $allmodule = '', $allperms = '', $entity = 0, $notrigger = 0) { @@ -759,7 +759,7 @@ class User extends CommonObject * Clear all permissions array of user * * @return void - * @see getrights + * @see getrights() */ public function clearrights() { @@ -777,7 +777,7 @@ class User extends CommonObject * @param string $moduletag Limit permission for a particular module ('' by default means load all permissions) * @param int $forcereload Force reload of permissions even if they were already loaded (ignore cache) * @return void - * @see clearrights, delrights, addrights + * @see clearrights(), delrights(), addrights() */ public function getrights($moduletag = '', $forcereload = 0) { @@ -3017,7 +3017,7 @@ class User extends CommonObject * * @param int $addcurrentuser 1=Add also current user id to the list. * @return array Array of user id lower than user (all levels under user). This overwrite this->users. - * @see get_children + * @see get_children() */ public function getAllChildIds($addcurrentuser = 0) {