Documentation Code Doxygen

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')

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

include/class/acc_operation_note.class.php

@@ -25,7 +25,7 @@
  */
 
 /*!
- * \class
+ * \class Acc_Operation_Note
  * \brief Manage the note attached to an operation
  */
 

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;

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
  *

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
+    /*! \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_FIN;

include/class/card_pdf.class.php

@@ -5,7 +5,7 @@
  *
  */
 /**
- * @class
+ * @class Card_PDF
  * @brief Class Card_PDF
  */
 class Card_PDF extends \PDF

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;

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 :
  * <ul>

include/class/manager.class.php

@@ -41,7 +41,7 @@ class Manager 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_EMPL;

include/class/noalyss_appearance.class.php

@@ -25,7 +25,7 @@
  */
 
 /**
- * @class
+ * @class Noalyss_Appearance
  * @brief Contains some parameters to change appearance of noalyss, the colors are saved
  * into the table parm_appearance
  */

include/class/operation_opening.class.php

@@ -23,7 +23,7 @@
  */
 
 /**
- * @class
+ * @class Operation_Opening
  * @brief Operation ouverture
  */
 class Operation_Opening extends Operation_Exercice

include/class/pre_operation.class.php

@@ -518,7 +518,7 @@ class Pre_operation
 }
 
 /*!
-@class
+@class Pre_operation_detail
 @brief mother of the pre_op_XXX, it contains only one data : an
  * object Pre_Operation. The child class contains an array of
  * Pre_Operation object

include/class/supplier.class.php

@@ -39,7 +39,7 @@ class Supplier 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_FOURNISSEUR;

include/database/operation_exercice_detail_sql.class.php

@@ -27,8 +27,8 @@
  */
 
 /**
- * @class
+ * @class Operation_Exercice_Detail_SQL
- * @brief  abstract of the table
+ * @brief  abstract of the table operation_exercice_detail
  */
 class Operation_Exercice_Detail_SQL extends Table_Data_SQL
 {

include/export/export_gl_csv.php

@@ -35,7 +35,7 @@
     [from_poste] => 
     [to_poste] => 
 )
-@encode
+@endcode
  */
 
 if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis');

include/lib/input_checkbox.class.php

@@ -28,7 +28,7 @@
  * value , either 1 or 0 EXPERIMENTAL
  */
 /**
- * @class
+ * @class InputCheckBox
  * @brief modern checkbox, using a javascript to change the icon when clicked and a hidden field, there is always a
  * value , either 1 or 0 , EXPERIMENTAL
  */

include/widget/event/event.php

@@ -25,7 +25,7 @@
 namespace Noalyss\Widget;
 
 /*!
- * \class
+ * \class Event
  * \brief show 10 next events , or 10 late
 */
 

unit-test/include/class/acc_ledger_purchaseTest.php

@@ -69,7 +69,7 @@ class Acc_Ledger_PurchaseTest extends TestCase
         $g_connection->exec_sql("
         INSERT INTO public.tmp_pcmn (pcm_val,pcm_lib,pcm_val_parent,pcm_type,pcm_direct_use) VALUES
 	 ('4119999','TVA Test UNIT','411','ACT','Y') on conflict  do nothing");
-        /// @var $array1 = used for autoreverse with 2 VAT Codes
+        //  variable: $array1 = used for autoreverse with 2 VAT Codes
         $this->array1=array (
             'e_client' => 'FOURNI1',
             'nb_item' => '10',