Code documentation

include/ajax/ajax_action_concerned_list.php

@@ -18,6 +18,10 @@
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  */
 
+/**
+ * @file
+ * @brief display list of other concerned person in Follow Up
+ */
 if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
 $http=new HttpInput();
 try {

include/ajax/ajax_bank_saldo.php

@@ -20,7 +20,8 @@
 
 // Copyright Author Dany De Bontridder danydb@aevalys.eu
 
-/* !\file
+/*!
+ * \file
  * \brief respond ajax request, the get contains
  *  the value :
  * - l for ledger
@@ -29,7 +30,8 @@
 
  */
 
-/* !\file
+/*!
+ * \file
  * \brief get the saldo of a account
  * the get variable are :
  *  - l the jrn id

include/ajax/ajax_forecast.php

@@ -18,7 +18,10 @@
 */
 
 // Copyright Author Dany De Bontridder danydb@noalyss.eu
-
+/**
+ * @file
+ * @brief FORECAST Edition
+ */
 if (!defined('ALLOWED')) die('Appel direct ne sont pas permis');
 
 require_once NOALYSS_INCLUDE . "/database/forecast_sql.class.php";

include/ajax/ajax_tag_set_group.php

@@ -25,7 +25,7 @@ if (!defined('ALLOWED'))
 
 /**
  * @file
- * @brief 
+ * @brief for module C0TAG , add or remove a set of tags
  */
 global $g_user;
 $g_user->can_request('C0TAG');

include/ajax/ajax_tva_parameter.php

@@ -24,8 +24,7 @@ if (!defined('ALLOWED'))
 
 /**
  * @file
- * @brief 
- * @param type $name Descriptionara
+ * @brief For the module C0TVA, save info 
  */
 
 if ( $g_user->check_module('C0TVA') ==0 )

include/class/acc_ledger_history.class.php

@@ -19,12 +19,13 @@
  */
 
 
-/***
+/**
  * @file 
  * @brief display or export operations in HTML , PDF or CSV 
  *
  */
 /**
+ * @class
  * @brief Display history of operation
  * @see acc_ledger_historyTest.php
  */

include/class/acc_ledger_history_sale.class.php

@@ -21,12 +21,13 @@
 
 /**
  * @file
- * @brief Acc_Ledger_History : Manage the list (history) of operations for display
+ * @brief Acc_Ledger_History_Sale : Manage the list (history) of operations for display
  * display or export operations in HTML , PDF or CSV 
  */
 
 /**
- * @brief Acc_Ledger_History : Manage the list (history) of operations for display
+ *@class Acc_Ledger_History_Sale
+ *@brief Acc_Ledger_History : Manage the list (history) of operations for display
  */
 class Acc_Ledger_History_Sale extends Acc_Ledger_History
 {

include/class/acc_reconciliation_lettering.class.php

@@ -19,14 +19,14 @@
  */
 
 
-/***
+/**
  * @file 
  * @brief this class let you insert reconcilied operation  from Lettering::save without calling auto_letter
  *
  */
 
-/***
- * @class
+/**
+ * @class Acc_Reconciliation_Lettering
  * @brief this class let you insert reconcilied operation  from Lettering::save without calling auto_letter
  *
  */

include/class/additional_tax.class.php

@@ -19,7 +19,15 @@
 
 // Copyright 2022 Author Dany De Bontridder dany@alchimerys.be
 
+/**
+ * @file
+ * @brief Class Additional_Tax : for additional class (France)
+ */
 
+/**
+ * @class Additional_Tax
+ * @brief Additional tax , Canada and France on sales
+ */
 class Additional_Tax
 {
     private $tax_amount;

include/class/document_state_mtable.class.php

@@ -20,7 +20,7 @@
  */
 
 
-/***
+/**
  * @file
  * @brief class Document_State_MTable
  * @see Manage_Table_SQL
@@ -28,6 +28,7 @@
  */
 require_once NOALYSS_INCLUDE.'/database/document_state_sql.class.php';
 /**
+ * @class Document_State_MTable
  * @brief this instance extends Manage_Table_SQL and aims to manage
  * the Table tmp_pcmn thanks a web interface (add , delete, display...)
  *

include/class/operation_closing.class.php

@@ -19,7 +19,11 @@
 // Copyright Author Dany De Bontridder danydb@aevalys.eu 6/01/24
 /*! 
  * \file
- * \brief 
+ * \brief  Closing operation
+ */
+/*!
+ * \class Operation_Closing
+ * \brief closing operation , end of exercice for French accountancy
  */
 class Operation_Closing extends Operation_Exercice
 {

include/class/operation_exercice.class.php

@@ -18,10 +18,14 @@
 */
 // Copyright Author Dany De Bontridder danydb@aevalys.eu 6/01/24
 /*!
- * \file
- * \brief
+ * \file 
+ * \brief Special operations end or start of exercice
  */
 
+/**
+ * @class Operation_Exercice
+ * @brief Special operations end or start of exercice
+ */
 class Operation_Exercice
 {
     protected $operation_exercice_sql;

include/constant.security.php

@@ -17,7 +17,10 @@
  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 // Copyright Author Dany De Bontridder danydb@aevalys.eu
-
+/**
+ * @file
+ * @brief define constant related to the security
+ */
 define ('FICADD',800);	 /* Ajout de fiche */
 define ("FIC",805);  //Création, modification et effacement de fiche
 define ("FICCAT",910);  //création, modification et effacement de catégorie de fiche

include/export/export_anc_grandlivre_csv.php

@@ -17,7 +17,10 @@
  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 // Copyright Author Dany De Bontridder danydb@aevalys.eu
-
+/**
+ * @file
+ * @brief Export Main Ledger in CSV
+ */
 if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
 header('Pragma: public');
 header('Content-type: application/csv');

include/export/export_anc_receipt_pdf.php

@@ -20,6 +20,10 @@
 
 // Copyright Author Dany De Bontridder danydb@aevalys.eu
 // Copyright Author Dany De Bontridder danydb@aevalys.eu
+/**
+ * @file 
+ * @brief export ANC Receipt with detail of operation and documents in PDF
+ */
 if (!defined('ALLOWED'))
     die('Appel direct ne sont pas permis');
 
@@ -27,7 +31,7 @@ if (!defined('ALLOWED'))
 session_write_close();
 
 /**
- * export all the selected documents for Ana Accountancy in PDF
+ * export all the selected documents for Anc Accountancy in PDF
  */
 $http=new HttpInput();
 $ck = $http->get('ck',"string", 0);

include/export/export_card_pdf.php

@@ -1,5 +1,5 @@
 <?php
-/***
+/**
  * @file
  * @brief output a PDF with card info
  *

include/export/export_printtva_csv.php

@@ -21,7 +21,7 @@
 // Copyright Author Dany De Bontridder danydb@noalyss.eu
 /**
  * @file
- * @brief
+ * @brief export in CSV P0TVA , Tax Summary 
  *
  */
 if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis');

include/export/export_rec_csv.php

@@ -3,7 +3,8 @@
 //see licence.txt
 
 /**
- * Export to CSV the operations asked in impress_rec.inc.php
+ * @file
+ * @brief Export to CSV the operations asked in impress_rec.inc.php
  * variable set $g_user,$cn
  * @see impress_rec.inc.php
  */