From 6909f2fa2bb24eff2d217640789c0b078362ef83 Mon Sep 17 00:00:00 2001 From: Dany De Bontridder Date: Mon, 18 Dec 2017 23:48:43 +0100 Subject: [PATCH] Improve Doxygen documentation --- include/ajax/ajax_accounting.php | 3 ++- include/ajax/ajax_action_remove_concerned.php | 5 ++++- include/ajax/ajax_action_save_concerned.php | 4 ++++ include/ajax/ajax_add_concerned_card.php | 4 ++++ include/ajax/ajax_anc_key_compute.php | 20 +++++++++++-------- include/ajax/ajax_anc_plan.php | 5 ++++- include/ajax/ajax_auto_anc_card.php | 7 +++++-- include/ajax/ajax_calendar_zoom.php | 4 ++++ include/ajax/ajax_create_menu.php | 4 ++++ include/ajax/ajax_display_letter.php | 7 ++++++- include/ajax/ajax_display_submenu.php | 1 + include/ajax/ajax_get_menu_detail.php | 2 +- include/ajax/ajax_ledger_show.php | 1 + include/ajax/ajax_min_row.php | 2 +- include/ajax/ajax_mod_menu.php | 4 ++++ include/ajax/ajax_navigator.php | 5 +++++ include/ajax/ajax_remove_submenu.php | 6 +++++- include/ajax/ajax_search_add_tag.php | 5 +++++ include/ajax/ajax_search_clear_tag.php | 5 +++++ include/ajax/ajax_search_display_tag.php | 5 +++++ include/ajax/ajax_tag_add_action.php | 6 ++++++ include/ajax/ajax_tag_detail.php | 1 + include/ajax/ajax_tag_list.php | 4 ++++ include/ajax/ajax_tag_remove_action.php | 4 ++++ include/ajax/ajax_tag_save.php | 6 +++++- include/ajax/ajax_tag_select_search.php | 6 +++++- include/anc_acc_balance.inc.php | 5 ++++- include/anc_acc_table.inc.php | 6 +++++- include/anc_balance_double.inc.php | 6 +++++- include/anc_balance_simple.inc.php | 6 +++++- include/anc_great_ledger.inc.php | 6 +++++- include/anc_group_balance.inc.php | 6 +++++- include/anc_history.inc.php | 6 +++++- include/anc_pa.inc.php | 4 ++-- include/balance_age.inc.php | 7 +++---- include/balance_card_ageing.inc.php | 4 ++-- include/cat_document.inc.php | 2 +- include/category_card.inc.php | 2 +- include/class/anc_balance_double.class.php | 15 +++++++------- include/dashboard.inc.php | 4 ++++ include/lib/filetosend.class.php | 9 +++++++++ include/lib/http_input.class.php | 11 ++++++++-- include/lib/icard.class.php | 17 ++++++++-------- include/lib/idate.class.php | 6 ++++-- include/lib/noalyss_csv.class.php | 7 ++++++- include/lib/pdf.class.php | 3 ++- include/lib/sendmail.class.php | 6 +++++- 47 files changed, 206 insertions(+), 58 deletions(-) diff --git a/include/ajax/ajax_accounting.php b/include/ajax/ajax_accounting.php index 066ed3d95..a0f6c81ff 100644 --- a/include/ajax/ajax_accounting.php +++ b/include/ajax/ajax_accounting.php @@ -23,7 +23,8 @@ if (!defined('ALLOWED')) die('Appel direct ne sont pas permis'); /** * @file - * @brief + * @brief Manange Accounting + * @see Acc_Plan_SQL */ $http=new HttpInput(); try { diff --git a/include/ajax/ajax_action_remove_concerned.php b/include/ajax/ajax_action_remove_concerned.php index 023a77397..31112dff6 100644 --- a/include/ajax/ajax_action_remove_concerned.php +++ b/include/ajax/ajax_action_remove_concerned.php @@ -20,7 +20,10 @@ // Copyright 2014 Author Dany De Bontridder danydb@aevalys.eu if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis'); - +/** + *@file + *@brief remove concerned operation , call from follow up + */ require_once NOALYSS_INCLUDE.'/lib/http_input.class.php'; $http=new HttpInput(); try diff --git a/include/ajax/ajax_action_save_concerned.php b/include/ajax/ajax_action_save_concerned.php index 5eb0aed79..e799b09f1 100644 --- a/include/ajax/ajax_action_save_concerned.php +++ b/include/ajax/ajax_action_save_concerned.php @@ -18,6 +18,10 @@ */ // Copyright 2014 Author Dany De Bontridder danydb@aevalys.eu +/** + *@file + *@brief insert concerned operation , call from follow up + */ // require_once '.php'; if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis'); diff --git a/include/ajax/ajax_add_concerned_card.php b/include/ajax/ajax_add_concerned_card.php index 1ea746883..a6b4c038d 100644 --- a/include/ajax/ajax_add_concerned_card.php +++ b/include/ajax/ajax_add_concerned_card.php @@ -20,6 +20,10 @@ // Copyright 2014 Author Dany De Bontridder danydb@aevalys.eu // require_once '.php'; +/** + *@file + *@brief insert concerned operation , call from follow up + */ if (!defined('ALLOWED')) die('Appel direct ne sont pas permis'); diff --git a/include/ajax/ajax_anc_key_compute.php b/include/ajax/ajax_anc_key_compute.php index 980fcf87c..c04d643f5 100644 --- a/include/ajax/ajax_anc_key_compute.php +++ b/include/ajax/ajax_anc_key_compute.php @@ -18,14 +18,18 @@ */ // Copyright 2014 Author Dany De Bontridder danydb@aevalys.eu -// @brief Compute the amount. This file compute the amount and distribute it -// following the given distribution key given in parameter. -// Parameters are : -// - gDossier -// - t the element HTML to use as target -// - amount the amount to distribute -// - key the Distribution key to use -// + + +/** + * @file + * @brief Compute the amount. This file compute the amount and distribute it + * following the given distribution key given in parameter. + * Parameters are : + - gDossier + - t the element HTML to use as target + - amount the amount to distribute + - key the Distribution key to use +*/ if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis'); require_once NOALYSS_INCLUDE.'/class/anc_key.class.php'; diff --git a/include/ajax/ajax_anc_plan.php b/include/ajax/ajax_anc_plan.php index b73a69237..88115cbb4 100644 --- a/include/ajax/ajax_anc_plan.php +++ b/include/ajax/ajax_anc_plan.php @@ -19,7 +19,10 @@ */ // Copyright Author Dany De Bontridder dany@alchimerys.be -///\file ajax answer to update or change name or description of an analytic plan + /** + *\file + *\brief ajax answer to update or change name or description of an analytic plan + */ if (!defined('ALLOWED')) die('Appel direct ne sont pas permis'); diff --git a/include/ajax/ajax_auto_anc_card.php b/include/ajax/ajax_auto_anc_card.php index 7b700c057..917154d86 100644 --- a/include/ajax/ajax_auto_anc_card.php +++ b/include/ajax/ajax_auto_anc_card.php @@ -1,7 +1,10 @@ exec_sql("select po_name,po_description from poste_analytique where pa_id=$1 ~* and (po_description ~* $2 or po_name ~* $3 order by po_id limit 12", + $res=$cn->exec_sql("select po_name,po_description from poste_analytique where pa_id=$1 and (po_description ~* $2 or po_name ~* $3) order by po_id limit 12", array($_REQUEST['pa_id'],$_POST['anccard'],$_POST['anccard'])); } else diff --git a/include/ajax/ajax_calendar_zoom.php b/include/ajax/ajax_calendar_zoom.php index 2f629505e..6d5ebe7e3 100644 --- a/include/ajax/ajax_calendar_zoom.php +++ b/include/ajax/ajax_calendar_zoom.php @@ -17,6 +17,10 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ // Copyright Author Dany De Bontridder danydb@aevalys.eu + /** + *@file + *@brief zoom the sheduler + */ if ( !defined ('ALLOWED') ) die('Appel direct ne sont pas permis'); require_once NOALYSS_INCLUDE.'/class/calendar.class.php'; require_once NOALYSS_INCLUDE.'/lib/http_input.class.php'; diff --git a/include/ajax/ajax_create_menu.php b/include/ajax/ajax_create_menu.php index 2e0ee9412..7633b3018 100644 --- a/include/ajax/ajax_create_menu.php +++ b/include/ajax/ajax_create_menu.php @@ -1,6 +1,10 @@ ag_id=$_REQUEST['ag_id']; diff --git a/include/ajax/ajax_tag_detail.php b/include/ajax/ajax_tag_detail.php index 28d456ebd..18c6e5f9f 100644 --- a/include/ajax/ajax_tag_detail.php +++ b/include/ajax/ajax_tag_detail.php @@ -1,5 +1,6 @@ '; diff --git a/include/anc_acc_table.inc.php b/include/anc_acc_table.inc.php index 7f0047a25..af9c18d9a 100644 --- a/include/anc_acc_table.inc.php +++ b/include/anc_acc_table.inc.php @@ -1,7 +1,11 @@ '; global $http; diff --git a/include/anc_group_balance.inc.php b/include/anc_group_balance.inc.php index 09b056a85..de1f1b61b 100644 --- a/include/anc_group_balance.inc.php +++ b/include/anc_group_balance.inc.php @@ -1,7 +1,11 @@ get('p_type','string','C'); $let=$http->get('p_let','string','unlet'); diff --git a/include/balance_card_ageing.inc.php b/include/balance_card_ageing.inc.php index a9a6f7bd5..218b6d7ba 100644 --- a/include/balance_card_ageing.inc.php +++ b/include/balance_card_ageing.inc.php @@ -22,8 +22,8 @@ if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis'); /** * @file - * @brief - * @param type $name Descriptionara + * @brief Aged Balance for card + *@see Balance_Age */ require_once NOALYSS_INCLUDE.'/class/exercice.class.php'; require_once NOALYSS_INCLUDE.'/class/balance_age.class.php'; diff --git a/include/cat_document.inc.php b/include/cat_document.inc.php index 5bae1ccd5..fe3a7b31c 100644 --- a/include/cat_document.inc.php +++ b/include/cat_document.inc.php @@ -20,7 +20,7 @@ // Copyright Author Dany De Bontridder danydb@aevalys.eu -/* !\file +/*!\file * \brief this file is included to perform modification on category of document * table document_type */ diff --git a/include/category_card.inc.php b/include/category_card.inc.php index c0357e423..4ba5274b5 100644 --- a/include/category_card.inc.php +++ b/include/category_card.inc.php @@ -20,7 +20,7 @@ // Copyright Author Dany De Bontridder danydb@aevalys.eu -/* !\file +/*!\file * \brief this file will handle all the actions for a specific customer ( * contact,operation,invoice and financial) * include from client.inc.php and concerned only the customer card and diff --git a/include/class/anc_balance_double.class.php b/include/class/anc_balance_double.class.php index 2c6be2840..67bd6524f 100644 --- a/include/class/anc_balance_double.class.php +++ b/include/class/anc_balance_double.class.php @@ -19,15 +19,11 @@ // Copyright Author Dany De Bontridder danydb@aevalys.eu -/*!\file - * \brief - * Print the crossed balance between 2 plan +/** + *@file + *@brief Print the crossed balance between 2 plan */ -/*! \brief - * Print the crossed balance between 2 plan - * - */ require_once NOALYSS_INCLUDE.'/lib/iselect.class.php'; require_once NOALYSS_INCLUDE.'/lib/itext.class.php'; require_once NOALYSS_INCLUDE.'/lib/ibutton.class.php'; @@ -35,6 +31,11 @@ require_once NOALYSS_INCLUDE.'/lib/ihidden.class.php'; require_once NOALYSS_INCLUDE.'/class/anc_print.class.php'; require_once NOALYSS_INCLUDE.'/class/anc_plan.class.php'; require_once NOALYSS_INCLUDE.'/lib/pdf.class.php'; +/** + * @class + * @brief Print the crossed balance between 2 plan + * + */ class Anc_Balance_Double extends Anc_Print { diff --git a/include/dashboard.inc.php b/include/dashboard.inc.php index 717312fb2..ab66694b2 100644 --- a/include/dashboard.inc.php +++ b/include/dashboard.inc.php @@ -1,5 +1,9 @@ accvis=1; } - /* !\brief set the javascript callback function + /**\brief set the javascript callback function * by default it is update_value called BEFORE the querystring is send * * \param $p_name callback function name @@ -164,7 +164,7 @@ class ICard extends HtmlInput $this->callback=$p_name; } - /* !\brief set the javascript callback function + /**\brief set the javascript callback function * by default it is update_value called AFTER an item has been selected * \param $p_name callback function name */ @@ -174,7 +174,7 @@ class ICard extends HtmlInput $this->fct=$p_name; } - /* !\brief return the html string for creating the ipopup, this ipopup + /**\brief return the html string for creating the ipopup, this ipopup * can be used for adding, modifying or display a card * @note ipopup is obsolete, the popin is created by javascript * \param $p_name name of the ipopup, must be set after with set_attribute @@ -203,7 +203,7 @@ class ICard extends HtmlInput return $ip_card->input(); } - /* !\brief set the extra javascript property for a double click on + /**\brief set the extra javascript property for a double click on * INPUT field * \param $p_action action when a double click happens * \note the $p_action cannot contain a double quote @@ -214,7 +214,7 @@ class ICard extends HtmlInput $this->dblclick=$p_action; } - /* !\brief show the html input of the widget */ + /**\brief show the html input of the widget */ public function input($p_name=null, $p_value=null) { @@ -271,7 +271,8 @@ class ICard extends HtmlInput return $r; } - /* !\brief print in html the readonly value of the widget */ + /** + \brief print in html the readonly value of the widget */ public function display() { diff --git a/include/lib/idate.class.php b/include/lib/idate.class.php index 9f71439ff..546f33d38 100644 --- a/include/lib/idate.class.php +++ b/include/lib/idate.class.php @@ -20,8 +20,10 @@ // Copyright Author Dany De Bontridder danydb@aevalys.eu -///!\file -//\brief Html Input + /** + *\file + \brief Html Input + */ /// Html Input : Input a date format dd.mm.yyyy diff --git a/include/lib/noalyss_csv.class.php b/include/lib/noalyss_csv.class.php index c01861083..86bf593c9 100644 --- a/include/lib/noalyss_csv.class.php +++ b/include/lib/noalyss_csv.class.php @@ -19,12 +19,17 @@ */ -/*** +/** * @file * @brief Manage the CSV : manage files and write CSV record * */ + +/** + * @brief Manage the CSV : manage files and write CSV record + * + */ class Noalyss_Csv { diff --git a/include/lib/pdf.class.php b/include/lib/pdf.class.php index ed7cd229d..636509fcd 100644 --- a/include/lib/pdf.class.php +++ b/include/lib/pdf.class.php @@ -20,7 +20,8 @@ // Copyright Author Dany De Bontridder danydb@aevalys.eu /*!\file - * \brief + * \brief API for creating PDF, unicode, based on tfpdf + *@see TFPDF */ require_once NOALYSS_INCLUDE.'/tfpdf/tfpdf.php'; diff --git a/include/lib/sendmail.class.php b/include/lib/sendmail.class.php index a6c409092..c41c96652 100644 --- a/include/lib/sendmail.class.php +++ b/include/lib/sendmail.class.php @@ -18,9 +18,13 @@ */ // Copyright Author Dany De Bontridder danydb@aevalys.eu +/** + *@file + *@brief API for sending email + */ /** - * Description of class_sendmail + * Description of Sendmail * * @author dany */