[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Noalyss-commit] [noalyss] 04/323: Improve Doxygen documentation
From: |
Dany De Bontridder |
Subject: |
[Noalyss-commit] [noalyss] 04/323: Improve Doxygen documentation |
Date: |
Wed, 14 Mar 2018 17:38:08 -0400 (EDT) |
sparkyx pushed a commit to branch master
in repository noalyss.
commit 6909f2fa2bb24eff2d217640789c0b078362ef83
Author: Dany De Bontridder <address@hidden>
Date: Mon Dec 18 23:48:43 2017 +0100
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 066ed3d..a0f6c81 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 023a773..31112df 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 address@hidden
if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
-
+/**
+ address@hidden
+ address@hidden 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 5eb0aed..e799b09 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 address@hidden
+/**
+ address@hidden
+ address@hidden 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 1ea7468..a6b4c03 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 address@hidden
// require_once '.php';
+/**
+ address@hidden
+ address@hidden 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 980fcf8..c04d643 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 address@hidden
-// @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 b73a692..88115cb 100644
--- a/include/ajax/ajax_anc_plan.php
+++ b/include/ajax/ajax_anc_plan.php
@@ -19,7 +19,10 @@
*/
// Copyright Author Dany De Bontridder address@hidden
-///\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 7b700c0..917154d 100644
--- a/include/ajax/ajax_auto_anc_card.php
+++ b/include/ajax/ajax_auto_anc_card.php
@@ -1,7 +1,10 @@
<?php
//This file is part of NOALYSS and is under GPL
//see licence.txt
-
+ /**
+ address@hidden
+ address@hidden no used ??
+ */
if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
require_once NOALYSS_INCLUDE.'/lib/database.class.php';
require_once NOALYSS_INCLUDE.'/class/user.class.php';
@@ -10,7 +13,7 @@ $cn=Dossier::connect();
if ( isset($_REQUEST['pa_id']) )
{
- $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",
+ $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 2f62950..6d5ebe7 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 address@hidden
+ /**
+ address@hidden
+ address@hidden 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 2e0ee94..7633b30 100644
--- a/include/ajax/ajax_create_menu.php
+++ b/include/ajax/ajax_create_menu.php
@@ -1,6 +1,10 @@
<?php
//This file is part of NOALYSS and is under GPL
//see licence.txt
+ /**
+ address@hidden
+ address@hidden Menu creation
+ */
if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
require_once NOALYSS_INCLUDE.'/class/menu_ref.class.php';
diff --git a/include/ajax/ajax_display_letter.php
b/include/ajax/ajax_display_letter.php
index c73fda2..c503243 100644
--- a/include/ajax/ajax_display_letter.php
+++ b/include/ajax/ajax_display_letter.php
@@ -19,7 +19,12 @@
*/
// Copyright 2015 Author Dany De Bontridder address@hidden
-// require_once '.php';
+
+ /**
+ address@hidden
+ address@hidden show the lettered operation
+ */
+
if (!defined('ALLOWED'))
die('Appel direct ne sont pas permis');
diff --git a/include/ajax/ajax_display_submenu.php
b/include/ajax/ajax_display_submenu.php
index 1b74d4d..e23a830 100644
--- a/include/ajax/ajax_display_submenu.php
+++ b/include/ajax/ajax_display_submenu.php
@@ -19,6 +19,7 @@
// Copyright 2015 Author Dany De Bontridder address@hidden
/**
+ * @file
* @brief call from ajax : display submenu
* Security : only user with the menu CFGPRO
* display the submenu of a menu or a module
diff --git a/include/ajax/ajax_get_menu_detail.php
b/include/ajax/ajax_get_menu_detail.php
index ff015a8..16dd63b 100644
--- a/include/ajax/ajax_get_menu_detail.php
+++ b/include/ajax/ajax_get_menu_detail.php
@@ -22,7 +22,7 @@
/**
* @file
- * @brief
+ * @brief get detail of a menu
*
*/
// retrieve data
diff --git a/include/ajax/ajax_ledger_show.php
b/include/ajax/ajax_ledger_show.php
index efaa80d..d948115 100644
--- a/include/ajax/ajax_ledger_show.php
+++ b/include/ajax/ajax_ledger_show.php
@@ -3,6 +3,7 @@
//see licence.txt
/**
+ address@hidden
* @brief
* Show a div for selecting ledger
* return a html code for creating a window
diff --git a/include/ajax/ajax_min_row.php b/include/ajax/ajax_min_row.php
index 687081c..bd92ec2 100644
--- a/include/ajax/ajax_min_row.php
+++ b/include/ajax/ajax_min_row.php
@@ -22,7 +22,7 @@
/**
* @file
- * @brief
+ * @brief return the number of rows for a ledger
*
*/
if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
diff --git a/include/ajax/ajax_mod_menu.php b/include/ajax/ajax_mod_menu.php
index 919736c..40d0ac7 100644
--- a/include/ajax/ajax_mod_menu.php
+++ b/include/ajax/ajax_mod_menu.php
@@ -1,6 +1,10 @@
<?php
//This file is part of NOALYSS and is under GPL
//see licence.txt
+ /**
+ address@hidden
+ address@hidden Menu modification
+ */
if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
require_once NOALYSS_INCLUDE.'/class/menu_ref.class.php';
diff --git a/include/ajax/ajax_navigator.php b/include/ajax/ajax_navigator.php
index 1347154..cdbf2ae 100644
--- a/include/ajax/ajax_navigator.php
+++ b/include/ajax/ajax_navigator.php
@@ -19,6 +19,11 @@
*/
// Copyright Author Dany De Bontridder address@hidden
+ /**
+ address@hidden
+ address@hidden display the navigator
+ */
+
if ( ! defined ('ALLOWED')) die('Appel direct ne sont pas permis');
echo HtmlInput::title_box(_("Navigateur"), "navi_div");
$sql="
diff --git a/include/ajax/ajax_remove_submenu.php
b/include/ajax/ajax_remove_submenu.php
index 43bb415..209295d 100644
--- a/include/ajax/ajax_remove_submenu.php
+++ b/include/ajax/ajax_remove_submenu.php
@@ -18,8 +18,12 @@
*/
// Copyright 2015 Author Dany De Bontridder address@hidden
+/**
address@hidden
address@hidden remove a submenu
+*/
+
-// require_once '.php';
if ( ! defined ('ALLOWED') ) die(_('Non autorisé'));
require_once NOALYSS_INCLUDE.'/lib/http_input.class.php';
$http=new HttpInput();
diff --git a/include/ajax/ajax_search_add_tag.php
b/include/ajax/ajax_search_add_tag.php
index fc58cc0..339b45c 100644
--- a/include/ajax/ajax_search_add_tag.php
+++ b/include/ajax/ajax_search_add_tag.php
@@ -18,6 +18,11 @@
*/
// Copyright Author Dany De Bontridder address@hidden
if ( !defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
+/**
+ address@hidden
+ address@hidden add tag , used for follow up
+ address@hidden Tag
+ */
require_once NOALYSS_INCLUDE.'/class/tag.class.php';
ob_start();
diff --git a/include/ajax/ajax_search_clear_tag.php
b/include/ajax/ajax_search_clear_tag.php
index d890139..3904e07 100644
--- a/include/ajax/ajax_search_clear_tag.php
+++ b/include/ajax/ajax_search_clear_tag.php
@@ -18,6 +18,11 @@
*/
// Copyright Author Dany De Bontridder address@hidden
if ( !defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
+/**
+ address@hidden
+ address@hidden remove tag , call from follow up
+ address@hidden Tag
+ */
require_once NOALYSS_INCLUDE.'/class/tag.class.php';
ob_start();
diff --git a/include/ajax/ajax_search_display_tag.php
b/include/ajax/ajax_search_display_tag.php
index ed5f4dd..59d9627 100644
--- a/include/ajax/ajax_search_display_tag.php
+++ b/include/ajax/ajax_search_display_tag.php
@@ -18,6 +18,11 @@
*/
// Copyright Author Dany De Bontridder address@hidden
if ( !defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
+/**
+ address@hidden
+ address@hidden remove tag , call from follow up
+ address@hidden Tag
+ */
require_once NOALYSS_INCLUDE.'/class/tag.class.php';
ob_start();
diff --git a/include/ajax/ajax_tag_add_action.php
b/include/ajax/ajax_tag_add_action.php
index f067f68..cdb4c4a 100644
--- a/include/ajax/ajax_tag_add_action.php
+++ b/include/ajax/ajax_tag_add_action.php
@@ -18,6 +18,12 @@
*/
// Copyright Author Dany De Bontridder address@hidden
if ( !defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
+/**
+ address@hidden
+ address@hidden remove tag , call from follow up
+ address@hidden Follow_Up
+ address@hidden Tag
+ */
$fl=new Follow_Up($cn);
$fl->ag_id=$_REQUEST['ag_id'];
diff --git a/include/ajax/ajax_tag_detail.php b/include/ajax/ajax_tag_detail.php
index 28d456e..18c6e5f 100644
--- a/include/ajax/ajax_tag_detail.php
+++ b/include/ajax/ajax_tag_detail.php
@@ -1,5 +1,6 @@
<?php
/**
+ address@hidden
* @brief display a window with the content of a tag
*/
//This file is part of NOALYSS and is under GPL
diff --git a/include/ajax/ajax_tag_list.php b/include/ajax/ajax_tag_list.php
index ee5c148..e80e932 100644
--- a/include/ajax/ajax_tag_list.php
+++ b/include/ajax/ajax_tag_list.php
@@ -17,6 +17,10 @@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
// Copyright Author Dany De Bontridder address@hidden
+ /**
+ address@hidden
+ address@hidden Display the list of tags
+ */
if ( !defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
require_once NOALYSS_INCLUDE.'/class/tag.class.php';
diff --git a/include/ajax/ajax_tag_remove_action.php
b/include/ajax/ajax_tag_remove_action.php
index 1451865..3f49b21 100644
--- a/include/ajax/ajax_tag_remove_action.php
+++ b/include/ajax/ajax_tag_remove_action.php
@@ -17,6 +17,10 @@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
// Copyright Author Dany De Bontridder address@hidden
+/**
+ address@hidden
+ address@hidden remove a tag from an event in the follow up
+ */
if ( !defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
$fl=new Follow_Up($cn);
diff --git a/include/ajax/ajax_tag_save.php b/include/ajax/ajax_tag_save.php
index 81109fa..439c668 100644
--- a/include/ajax/ajax_tag_save.php
+++ b/include/ajax/ajax_tag_save.php
@@ -1,7 +1,11 @@
<?php
//This file is part of NOALYSS and is under GPL
//see licence.txt
-
+/**
+ address@hidden
+ address@hidden save a new tag
+ address@hidden Tag
+ */
if ( !defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
require_once NOALYSS_INCLUDE.'/class/tag.class.php';
diff --git a/include/ajax/ajax_tag_select_search.php
b/include/ajax/ajax_tag_select_search.php
index 575737e..f5f9462 100644
--- a/include/ajax/ajax_tag_select_search.php
+++ b/include/ajax/ajax_tag_select_search.php
@@ -18,7 +18,11 @@
*/
// Copyright Author Dany De Bontridder address@hidden
if ( !defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
-
+/**
+ address@hidden
+ address@hidden Show the tags to select
+ address@hidden Tag
+ */
require_once NOALYSS_INCLUDE.'/class/tag.class.php';
ob_start();
$tag=new Tag($cn);
diff --git a/include/anc_acc_balance.inc.php b/include/anc_acc_balance.inc.php
index c9f72b2..646376f 100644
--- a/include/anc_acc_balance.inc.php
+++ b/include/anc_acc_balance.inc.php
@@ -1,7 +1,10 @@
<?php
//This file is part of NOALYSS and is under GPL
//see licence.txt
-
+/**
+ * @file
+ * @brief Module Balance Accountancy - Analyc
+ */
if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
require_once NOALYSS_INCLUDE.'/class/anc_acc_list.class.php';
echo '<div class="content">';
diff --git a/include/anc_acc_table.inc.php b/include/anc_acc_table.inc.php
index 7f0047a..af9c18d 100644
--- a/include/anc_acc_table.inc.php
+++ b/include/anc_acc_table.inc.php
@@ -1,7 +1,11 @@
<?php
//This file is part of NOALYSS and is under GPL
//see licence.txt
-
+/**
+ * @file
+ * @brief Module Printing : Analytic to display relation between card or
accounting with
+ * Analytic
+ */
if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
require_once NOALYSS_INCLUDE.'/class/anc_table.class.php';
$tab = new Anc_Table($cn);
diff --git a/include/anc_balance_double.inc.php
b/include/anc_balance_double.inc.php
index a1ac670..b8ab929 100644
--- a/include/anc_balance_double.inc.php
+++ b/include/anc_balance_double.inc.php
@@ -1,7 +1,11 @@
<?php
//This file is part of NOALYSS and is under GPL
//see licence.txt
-
+/**
+ address@hidden
+ address@hidden Print the crossed balance between 2 plan
+ address@hidden Anc_Balance_Double
+ */
if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
require_once NOALYSS_INCLUDE.'/class/anc_balance_double.class.php';
$bc = new Anc_Balance_Double($cn);
diff --git a/include/anc_balance_simple.inc.php
b/include/anc_balance_simple.inc.php
index d0dac9f..af25310 100644
--- a/include/anc_balance_simple.inc.php
+++ b/include/anc_balance_simple.inc.php
@@ -1,7 +1,11 @@
<?php
//This file is part of NOALYSS and is under GPL
//see licence.txt
-
+/**
+ address@hidden
+ address@hidden Print the balance of 1 plan
+ * @see Anc_Balance_Simple
+ */
if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
require_once NOALYSS_INCLUDE.'/class/anc_balance_simple.class.php';
$bs = new Anc_Balance_Simple($cn);
diff --git a/include/anc_great_ledger.inc.php b/include/anc_great_ledger.inc.php
index 32737ea..0ecb747 100644
--- a/include/anc_great_ledger.inc.php
+++ b/include/anc_great_ledger.inc.php
@@ -1,7 +1,11 @@
<?php
//This file is part of NOALYSS and is under GPL
//see licence.txt
-
+/**
+ address@hidden
+ address@hidden Print the great ledger for Analytic accounting
+ * @see Anc_GrandLivre
+ */
if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
echo '<div style="content">';
global $http;
diff --git a/include/anc_group_balance.inc.php
b/include/anc_group_balance.inc.php
index 09b056a..de1f1b6 100644
--- a/include/anc_group_balance.inc.php
+++ b/include/anc_group_balance.inc.php
@@ -1,7 +1,11 @@
<?php
//This file is part of NOALYSS and is under GPL
//see licence.txt
-
+/**
+ address@hidden
+ address@hidden Print the balance of 1 plan of analytic accountancy separated
by group
+ * @see Anc_Group
+ */
if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
require_once NOALYSS_INCLUDE.'/class/anc_group.class.php';
diff --git a/include/anc_history.inc.php b/include/anc_history.inc.php
index 1901dcb..bac4a8b 100644
--- a/include/anc_history.inc.php
+++ b/include/anc_history.inc.php
@@ -2,7 +2,11 @@
//This file is part of NOALYSS and is under GPL
//see licence.txt
-
+/**
+ address@hidden
+ address@hidden Print history for Analytic accounting
+ * @see Anc_Listing
+ */
if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
require_once NOALYSS_INCLUDE.'/class/anc_listing.class.php';
diff --git a/include/anc_pa.inc.php b/include/anc_pa.inc.php
index 0048df4..d721e64 100644
--- a/include/anc_pa.inc.php
+++ b/include/anc_pa.inc.php
@@ -20,9 +20,9 @@
// Copyright Author Dany De Bontridder address@hidden
-/* !\file
+/*!\file
*
- * \brief Plan Analytique
+ *\brief Plan Analytique
*
*/
if (!defined('ALLOWED'))
diff --git a/include/balance_age.inc.php b/include/balance_age.inc.php
index f8a2232..4f696e4 100644
--- a/include/balance_age.inc.php
+++ b/include/balance_age.inc.php
@@ -21,11 +21,10 @@
if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
global $http;
/**
- * @file
- * @brief
- * @param type $name Descriptionara
+ address@hidden
+ address@hidden Print the aged balance for accountancy see
+ * @see Balance_Age
*/
-
$type=$http->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 a9a6f7b..218b6d7 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
+ address@hidden 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 5bae1cc..fe3a7b3 100644
--- a/include/cat_document.inc.php
+++ b/include/cat_document.inc.php
@@ -20,7 +20,7 @@
// Copyright Author Dany De Bontridder address@hidden
-/* !\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 c0357e4..4ba5274 100644
--- a/include/category_card.inc.php
+++ b/include/category_card.inc.php
@@ -20,7 +20,7 @@
// Copyright Author Dany De Bontridder address@hidden
-/* !\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 2c6be28..67bd652 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 address@hidden
-/*!\file
- * \brief
- * Print the crossed balance between 2 plan
+/**
+ address@hidden
+ address@hidden 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 717312f..ab66694 100644
--- a/include/dashboard.inc.php
+++ b/include/dashboard.inc.php
@@ -1,5 +1,9 @@
<?php
if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
+/**
+ address@hidden
+ address@hidden Dashboard
+ */
require_once NOALYSS_INCLUDE.'/lib/idate.class.php';
require_once NOALYSS_INCLUDE.'/lib/itext.class.php';
require_once NOALYSS_INCLUDE.'/constant.php';
diff --git a/include/lib/filetosend.class.php b/include/lib/filetosend.class.php
index af9b4b3..fa9b4e3 100644
--- a/include/lib/filetosend.class.php
+++ b/include/lib/filetosend.class.php
@@ -18,11 +18,20 @@
*/
// Copyright Author Dany De Bontridder address@hidden
/**
+ address@hidden
* @brief file to add to a message
*
* @see Sendmail
* @author dany
*/
+
+/**
+ * @brief file to add to a message
+ *
+ * @see Sendmail
+ * @author dany
+ */
+
class FileToSend
{
/**
diff --git a/include/lib/http_input.class.php b/include/lib/http_input.class.php
index bdaf97a..c77273f 100644
--- a/include/lib/http_input.class.php
+++ b/include/lib/http_input.class.php
@@ -21,8 +21,15 @@
/**
* @file
- * @brief
+ * @brief manage the http input (get , post, request)
*/
+
+
+/**
+ * @file
+ * @brief manage the http input (get , post, request)
+ */
+
class HttpInput
{
@@ -34,7 +41,7 @@ class HttpInput
}
/**
- *
+ * Check the type of the value
* @param $p_name name of the variable
* @param $p_type type of the variable (number,string,date,array)
* @throws Exception if the variable doesn't exist or type incorrect
diff --git a/include/lib/icard.class.php b/include/lib/icard.class.php
index 6567b7b..49c86b2 100644
--- a/include/lib/icard.class.php
+++ b/include/lib/icard.class.php
@@ -20,12 +20,12 @@
// Copyright Author Dany De Bontridder address@hidden
-/* !\file
+/**\file
* \brief Input HTML for the card show buttons
*
*/
-/* !
+/**
* \brief Input HTML for the card show buttons, in the file, you have to add
card.js
* How to use :
* - label is the label in the button
@@ -153,7 +153,7 @@ class ICard extends HtmlInput
$this->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 9f71439..546f33d 100644
--- a/include/lib/idate.class.php
+++ b/include/lib/idate.class.php
@@ -20,8 +20,10 @@
// Copyright Author Dany De Bontridder address@hidden
-///!\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 c018610..86bf593 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 ed7cd22..636509f 100644
--- a/include/lib/pdf.class.php
+++ b/include/lib/pdf.class.php
@@ -20,7 +20,8 @@
// Copyright Author Dany De Bontridder address@hidden
/*!\file
- * \brief
+ * \brief API for creating PDF, unicode, based on tfpdf
+ address@hidden TFPDF
*/
require_once NOALYSS_INCLUDE.'/tfpdf/tfpdf.php';
diff --git a/include/lib/sendmail.class.php b/include/lib/sendmail.class.php
index a6c4090..c41c966 100644
--- a/include/lib/sendmail.class.php
+++ b/include/lib/sendmail.class.php
@@ -18,9 +18,13 @@
*/
// Copyright Author Dany De Bontridder address@hidden
+/**
+ address@hidden
+ address@hidden API for sending email
+ */
/**
- * Description of class_sendmail
+ * Description of Sendmail
*
* @author dany
*/
- [Noalyss-commit] [noalyss] 78/323: esthetic, (continued)
- [Noalyss-commit] [noalyss] 78/323: esthetic, Dany De Bontridder, 2018/03/14
- [Noalyss-commit] [noalyss] 70/323: Task #0001530: Réécriture PRINTJRN : export CSV : Purchase List (L), Dany De Bontridder, 2018/03/14
- [Noalyss-commit] [noalyss] 73/323: Missing import of icon_action, Dany De Bontridder, 2018/03/14
- [Noalyss-commit] [noalyss] 75/323: Merge branch 'rewrite-printjrn', Dany De Bontridder, 2018/03/14
- [Noalyss-commit] [noalyss] 76/323: Small bug in save_card, Dany De Bontridder, 2018/03/14
- [Noalyss-commit] [noalyss] 71/323: task #1531: Historique poste et fiche d'après exercice opération, Dany De Bontridder, 2018/03/14
- [Noalyss-commit] [noalyss] 83/323: Esthétique Recherche action, Dany De Bontridder, 2018/03/14
- [Noalyss-commit] [noalyss] 68/323: Task #0001530: Réécriture PRINTJRN Add Financial Ledger Adapt test file, Dany De Bontridder, 2018/03/14
- [Noalyss-commit] [noalyss] 61/323: Fix some issues with PRINTJRN, Dany De Bontridder, 2018/03/14
- [Noalyss-commit] [noalyss] 79/323: before deleting a card , check if it is not used as an attribute in another card, Dany De Bontridder, 2018/03/14
- [Noalyss-commit] [noalyss] 04/323: Improve Doxygen documentation,
Dany De Bontridder <=
- [Noalyss-commit] [noalyss] 60/323: remove deprecated theme, Dany De Bontridder, 2018/03/14
- [Noalyss-commit] [noalyss] 56/323: Task #0001527: Effacement du champ code fiche : bouton, Dany De Bontridder, 2018/03/14
- [Noalyss-commit] [noalyss] 43/323: Rewriting Change class Own by Noalyss_Parameter_Folder, Dany De Bontridder, 2018/03/14
- [Noalyss-commit] [noalyss] 84/323: Doc, Dany De Bontridder, 2018/03/14
- [Noalyss-commit] [noalyss] 81/323: task #1531: Historique poste et fiche d'après exercice opération Fait aussi pour le bouton historique, Dany De Bontridder, 2018/03/14
- [Noalyss-commit] [noalyss] 85/323: cosmetique, Dany De Bontridder, 2018/03/14
- [Noalyss-commit] [noalyss] 82/323: Esthétique Recherche action, Dany De Bontridder, 2018/03/14
- [Noalyss-commit] [noalyss] 88/323: comment, Dany De Bontridder, 2018/03/14
- [Noalyss-commit] [noalyss] 93/323: Predefined operation fix cosmetic, Dany De Bontridder, 2018/03/14
- [Noalyss-commit] [noalyss] 90/323: Icon_Action replace image by fontello, Dany De Bontridder, 2018/03/14