From a89fff96117d083a6bf9295fc661ab629f026dee Mon Sep 17 00:00:00 2001 From: sparkyx Date: Sat, 21 Dec 2024 11:12:26 +0100 Subject: [PATCH] Documentation Code Doxygen --- include/class/acc_ledger_purchase.class.php | 22 +++++++++---------- include/class/acc_ledger_sale.class.php | 16 +++++++------- include/class/acc_operation_note.class.php | 2 +- include/class/admin.class.php | 2 +- include/class/anticipation.class.php | 2 +- include/class/bank.class.php | 3 +-- include/class/card_pdf.class.php | 2 +- include/class/customer.class.php | 3 ++- include/class/follow_up.class.php | 2 +- include/class/manager.class.php | 2 +- include/class/noalyss_appearance.class.php | 2 +- include/class/operation_opening.class.php | 2 +- include/class/pre_operation.class.php | 2 +- include/class/supplier.class.php | 2 +- .../operation_exercice_detail_sql.class.php | 4 ++-- include/export/export_gl_csv.php | 2 +- include/lib/input_checkbox.class.php | 2 +- include/widget/event/event.php | 2 +- .../include/class/acc_ledger_purchaseTest.php | 2 +- 19 files changed, 38 insertions(+), 38 deletions(-) diff --git a/include/class/acc_ledger_purchase.class.php b/include/class/acc_ledger_purchase.class.php index 0e7f65e7e..e9be6ad84 100644 --- a/include/class/acc_ledger_purchase.class.php +++ b/include/class/acc_ledger_purchase.class.php @@ -554,36 +554,36 @@ class Acc_Ledger_Purchase extends Acc_Ledger try { bcscale(4); - /// @var $tot_amount float : total amount of the purchase (debit) + // variable : $tot_amount float : total amount of the purchase (debit) $tot_amount=0; - /// @var $tot_tva float : total amount of the VAT + // variable : $tot_tva float : total amount of the VAT $tot_tva=0; $tot_debit=0; $this->db->start(); - /// @var $tot_nd float total not Deductible + // variable : $tot_nd float total not Deductible $tot_nd=0; - /// @var $tot_perso float total private amount + // variable : $tot_perso float total private amount $tot_perso=0; - /// @var $tot_tva_nd float total vat not deductible + // variable : $tot_tva_nd float total vat not deductible $tot_tva_nd=0; - /// @var $tot_tva_ndded float total vat not deductible - deductible via another tax + // variable : $tot_tva_ndded float total vat not deductible - deductible via another tax $tot_tva_ndded=0; $tot_tva_reversed=0; //@todo to remove - /// @var $tva array that will contain all the VAT Amount + // variable : $tva array that will contain all the VAT Amount $tva=array(); - /// @var $tva_reverse array that contain all the VAT autoreverse AND negative + // variable : $tva_reverse array that contain all the VAT autoreverse AND negative $tva_reverse = array(); - /// @var $tot_amount_cur : total amount in currency + // variable : $tot_amount_cur : total amount in currency $tot_amount_cur=0; // find the currency from v_currency_last_value - /// @var $currency_rate_ref Acc_Currency , currency object for this operation + // variable : $currency_rate_ref Acc_Currency , currency object for this operation $currency_rate_ref=new Acc_Currency($this->db, $p_currency_code); /* Save all the items without vat and no deductible vat and expense*/ @@ -594,7 +594,7 @@ class Acc_Ledger_Purchase extends Acc_Ledger /* First we save all the items without vat */ $fiche=new Fiche($this->db); $fiche->get_by_qcode(${"e_march".$i}); - /// @var $tva_both integer 1 for autoreverse ,0 normal, fetch it once for this item, + // variable : $tva_both integer 1 for autoreverse ,0 normal, fetch it once for this item, $tva_both=0; /* tva */ if ($g_parameter->MY_TVA_USE=='Y') diff --git a/include/class/acc_ledger_sale.class.php b/include/class/acc_ledger_sale.class.php index 2fe998e09..9ade61786 100644 --- a/include/class/acc_ledger_sale.class.php +++ b/include/class/acc_ledger_sale.class.php @@ -300,28 +300,28 @@ class Acc_Ledger_Sale extends Acc_Ledger { bcscale(4); try { - /// @var $tot_amount : total amount of the sales (credit) + // variable : $tot_amount : total amount of the sales (credit) $tot_amount = 0; - /// @var $tot_tva : total amount of the VAT + // variable : $tot_tva : total amount of the VAT $tot_tva = 0; // tot debit if item's amount < 0 $tot_debit = 0; - /// @var $tot_amount_cur : total amount in currency + // variable : $tot_amount_cur : total amount in currency $tot_amount_cur=0; $this->db->start(); - /// @var $tva array that will contain all the VAT Amount + // variable : $tva array that will contain all the VAT Amount $tva = array(); - /// @var $tva_reverse array that contain all the VAT autoreverse AND negative + // variable : $tva_reverse array that contain all the VAT autoreverse AND negative $tva_reverse = array(); // find the currency from v_currency_last_value - /// @var $currency_rate_ref Acc_Currency , currency object for this operation + // variable : $currency_rate_ref Acc_Currency , currency object for this operation $currency_rate_ref=new Acc_Currency($this->db, $p_currency_code); /* Save all the items without vat */ for ($i = 0; $i < $nb_item; $i++) { - /// @var $n_both float auto-reverse amount + // variable : $n_both float auto-reverse amount $n_both = 0; if ( empty(${'e_march'.$i}) || empty(${'e_quant'.$i}) ) continue; @@ -374,7 +374,7 @@ class Acc_Ledger_Sale extends Acc_Ledger { /* Compute sum vat */ $oTva = Acc_Tva::build($this->db, trim(${'e_march' . $i . '_tva_id'})); $idx_tva =$oTva->get_parameter("id"); - /// @var $auto_reverse = if the oTVA autoreverse, fetch it once for this item, + // variable : $auto_reverse = if the oTVA autoreverse, fetch it once for this item, $auto_reverse=$oTva->get_parameter("both_side"); $tva_item_currency = ${'e_march' . $i . '_tva_amount'}; diff --git a/include/class/acc_operation_note.class.php b/include/class/acc_operation_note.class.php index 9a2638347..c6188b6e8 100644 --- a/include/class/acc_operation_note.class.php +++ b/include/class/acc_operation_note.class.php @@ -25,7 +25,7 @@ */ /*! - * \class + * \class Acc_Operation_Note * \brief Manage the note attached to an operation */ diff --git a/include/class/admin.class.php b/include/class/admin.class.php index e22468b5b..a90254638 100644 --- a/include/class/admin.class.php +++ b/include/class/admin.class.php @@ -40,7 +40,7 @@ class Admin extends Fiche var $vat_number; /*!< $vat_number vat number */ /*! \brief Constructor - /* only a db connection is needed */ + * only a db connection is needed */ function __construct($p_cn,$p_id=0) { $this->fiche_def_ref=FICHE_TYPE_ADM_TAX; diff --git a/include/class/anticipation.class.php b/include/class/anticipation.class.php index 9ed971254..1e43a1f14 100644 --- a/include/class/anticipation.class.php +++ b/include/class/anticipation.class.php @@ -25,7 +25,7 @@ * */ /** - * @class + * @class Anticipation * @brief Manage the anticipation of expense, sales,... * @see Forecast Forecast_Cat Forecast_Item * diff --git a/include/class/bank.class.php b/include/class/bank.class.php index cb77756fc..0ab215cb7 100644 --- a/include/class/bank.class.php +++ b/include/class/bank.class.php @@ -39,8 +39,7 @@ class Bank extends Fiche var $cp; /*!< $cp Zip code */ var $vat_number; /*!< $vat_number vat number */ - /*! \brief Constructor - /* only a db connection is needed */ + /*! \brief Constructor only a db connection is needed */ function __construct($p_cn,$p_id=0) { $this->fiche_def_ref=FICHE_TYPE_FIN; diff --git a/include/class/card_pdf.class.php b/include/class/card_pdf.class.php index 08a570ba3..366a51c30 100644 --- a/include/class/card_pdf.class.php +++ b/include/class/card_pdf.class.php @@ -5,7 +5,7 @@ * */ /** - * @class + * @class Card_PDF * @brief Class Card_PDF */ class Card_PDF extends \PDF diff --git a/include/class/customer.class.php b/include/class/customer.class.php index 1a16872b2..4217e04b1 100644 --- a/include/class/customer.class.php +++ b/include/class/customer.class.php @@ -39,7 +39,8 @@ class Customer extends Fiche var $vat_number; /*!< $vat_number vat number */ /*! \brief Constructor - /* only a db connection is needed */ + * only a db connection is needed + */ function __construct($p_cn,$p_id=0) { $this->fiche_def_ref=FICHE_TYPE_CLIENT; diff --git a/include/class/follow_up.class.php b/include/class/follow_up.class.php index c058174ad..6f0748dd5 100644 --- a/include/class/follow_up.class.php +++ b/include/class/follow_up.class.php @@ -34,7 +34,7 @@ require_once NOALYSS_INCLUDE.'/lib/user_common.php'; */ /** - * \class + * \class Follow_Up * \brief class_action for manipulating actions * action can be : *