From ece5c32d861ae912147cfb3df0cc536f95fe1694 Mon Sep 17 00:00:00 2001 From: sparkyx Date: Sat, 21 Jun 2025 16:13:15 +0200 Subject: [PATCH] Code documentation --- include/ajax/ajax_action_concerned_list.php | 4 ++++ include/ajax/ajax_bank_saldo.php | 6 ++++-- include/ajax/ajax_forecast.php | 5 ++++- include/ajax/ajax_tag_set_group.php | 2 +- include/ajax/ajax_tva_parameter.php | 3 +-- include/class/acc_ledger_history.class.php | 3 ++- include/class/acc_ledger_history_sale.class.php | 5 +++-- include/class/acc_reconciliation_lettering.class.php | 6 +++--- include/class/additional_tax.class.php | 8 ++++++++ include/class/document_state_mtable.class.php | 3 ++- include/class/operation_closing.class.php | 6 +++++- include/class/operation_exercice.class.php | 8 ++++++-- include/constant.security.php | 5 ++++- include/export/export_anc_grandlivre_csv.php | 5 ++++- include/export/export_anc_receipt_pdf.php | 6 +++++- include/export/export_card_pdf.php | 2 +- include/export/export_printtva_csv.php | 2 +- include/export/export_rec_csv.php | 3 ++- 18 files changed, 60 insertions(+), 22 deletions(-) diff --git a/include/ajax/ajax_action_concerned_list.php b/include/ajax/ajax_action_concerned_list.php index 973ea24c9..321ad9c8d 100644 --- a/include/ajax/ajax_action_concerned_list.php +++ b/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 { diff --git a/include/ajax/ajax_bank_saldo.php b/include/ajax/ajax_bank_saldo.php index e8f2deb7f..1d69ee0c5 100644 --- a/include/ajax/ajax_bank_saldo.php +++ b/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 diff --git a/include/ajax/ajax_forecast.php b/include/ajax/ajax_forecast.php index 1e94320f8..afe5b7e2c 100644 --- a/include/ajax/ajax_forecast.php +++ b/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"; diff --git a/include/ajax/ajax_tag_set_group.php b/include/ajax/ajax_tag_set_group.php index 17b835463..764a790a5 100644 --- a/include/ajax/ajax_tag_set_group.php +++ b/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'); diff --git a/include/ajax/ajax_tva_parameter.php b/include/ajax/ajax_tva_parameter.php index e082027a2..d05538d38 100644 --- a/include/ajax/ajax_tva_parameter.php +++ b/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 ) diff --git a/include/class/acc_ledger_history.class.php b/include/class/acc_ledger_history.class.php index 38b2b8847..49576bef9 100644 --- a/include/class/acc_ledger_history.class.php +++ b/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 */ diff --git a/include/class/acc_ledger_history_sale.class.php b/include/class/acc_ledger_history_sale.class.php index 0240db9b1..8da3232db 100644 --- a/include/class/acc_ledger_history_sale.class.php +++ b/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 { diff --git a/include/class/acc_reconciliation_lettering.class.php b/include/class/acc_reconciliation_lettering.class.php index c6789278d..87e69a73f 100644 --- a/include/class/acc_reconciliation_lettering.class.php +++ b/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 * */ diff --git a/include/class/additional_tax.class.php b/include/class/additional_tax.class.php index cec720697..62cbac4e5 100644 --- a/include/class/additional_tax.class.php +++ b/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; diff --git a/include/class/document_state_mtable.class.php b/include/class/document_state_mtable.class.php index 19754e974..36fb54c0e 100644 --- a/include/class/document_state_mtable.class.php +++ b/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...) * diff --git a/include/class/operation_closing.class.php b/include/class/operation_closing.class.php index 07dd59a18..37541ea5f 100644 --- a/include/class/operation_closing.class.php +++ b/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 { diff --git a/include/class/operation_exercice.class.php b/include/class/operation_exercice.class.php index 2c9f895db..9a5831ce6 100644 --- a/include/class/operation_exercice.class.php +++ b/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; diff --git a/include/constant.security.php b/include/constant.security.php index a6de1d91c..e076c04db 100644 --- a/include/constant.security.php +++ b/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 diff --git a/include/export/export_anc_grandlivre_csv.php b/include/export/export_anc_grandlivre_csv.php index 734e62c26..aab595f32 100644 --- a/include/export/export_anc_grandlivre_csv.php +++ b/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'); diff --git a/include/export/export_anc_receipt_pdf.php b/include/export/export_anc_receipt_pdf.php index c24906b7a..6c1f9c110 100644 --- a/include/export/export_anc_receipt_pdf.php +++ b/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); diff --git a/include/export/export_card_pdf.php b/include/export/export_card_pdf.php index 795f979d5..8745f0045 100644 --- a/include/export/export_card_pdf.php +++ b/include/export/export_card_pdf.php @@ -1,5 +1,5 @@