[Noalyss-commit] [noalyss] 09/26: Documentation

[Dany De Bontridder]

sparkyx pushed a commit to branch master
in repository noalyss.

commit 108de76fbd7baf9ff7522c52e6689449b586b277
Author: Dany wm De Bontridder <danydb@noalyss.eu>
AuthorDate: Thu Jul 29 21:19:27 2021 +0200

    Documentation
---
 doc/developper/Doxyfile                          |  2 +-
 html/direct.php                                  |  5 ++++-
 html/js/acc_ledger.js                            |  8 +++++---
 include/ajax/ajax_save_predf_op.php              |  4 ++--
 include/class/extension.class.php                |  6 +++++-
 include/class/menu_ref.class.php                 |  2 +-
 include/class/operation_predef_mtable.class.php  | 12 ++++++------
 include/database/forecast_category_sql.class.php |  7 ++++++-
 include/database/forecast_item_sql.class.php     |  4 ++++
 include/database/forecast_sql.class.php          |  6 +++++-
 include/database/form_definition_sql.class.php   |  3 +++
 include/database/form_detail_sql.class.php       |  3 +++
 include/database/jrn_def_sql.class.php           |  3 +++
 include/database/op_predef_sql.class.php         |  4 ++--
 include/database/stock_goods_sql.class.php       | 10 +++++++++-
 include/database/stock_sql.class.php             |  7 ++++++-
 include/database/tag_group_sql.class.php         |  9 ++++++++-
 include/database/tmp_pcmn_sql.class.php          |  9 +++++++--
 include/database/tva_rate_sql.class.php          |  5 +++++
 include/database/user_filter_sql.class.php       |  5 +++++
 include/database/v_tva_rate_sql.class.php        |  6 +++++-
 include/menu.inc.php                             |  5 +++--
 include/preod.inc.php                            |  4 ++--
 23 files changed, 100 insertions(+), 29 deletions(-)

diff --git a/doc/developper/Doxyfile b/doc/developper/Doxyfile
index 9901901..515e968 100644
--- a/doc/developper/Doxyfile
+++ b/doc/developper/Doxyfile
@@ -683,7 +683,7 @@ EXCLUDE_PATTERNS       = a?.php \
                        scriptaculous.js \
                        slider.js \
                        sound.js \
-                       unittest.js.
+                       unittest.js
 
 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
diff --git a/html/direct.php b/html/direct.php
index d08d460..50e6953 100644
--- a/html/direct.php
+++ b/html/direct.php
@@ -17,7 +17,10 @@
  *   along with NOALYSS; if not, write to the Free Software
  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
-
+/**
+ * @file
+ * @brief used by the autocomplete feature of the Direct Access
+ */
 require_once '../include/constant.php';
 require_once NOALYSS_INCLUDE.'/class/database.class.php';
 require_once NOALYSS_INCLUDE.'/class/user.class.php';
diff --git a/html/js/acc_ledger.js b/html/js/acc_ledger.js
index de50775..8b077ce 100644
--- a/html/js/acc_ledger.js
+++ b/html/js/acc_ledger.js
@@ -19,14 +19,16 @@
 
 // Copyright Author Dany De Bontridder danydb@aevalys.eu
 
-/*!\file
+/*!
+ * \file
  * \brief javascript script for the ledger in accountancy,
  * compute the sum, add a row at the table..
  *
  */
 var layer = 1;
 /**
- *  update the list of available predefined operation when we change the 
ledger.
+ * \fn
+ * \brief update the list of available predefined operation when we change the 
ledger.
  */
 function update_predef(p_type, p_direct, p_ac)
 {
@@ -1561,4 +1563,4 @@ function duplicate_operation(p_dossier,p_jr_id) {
                         }
                     
                     );
-}
\ No newline at end of file
+}
diff --git a/include/ajax/ajax_save_predf_op.php 
b/include/ajax/ajax_save_predf_op.php
index a87f1ed..7a23d37 100644
--- a/include/ajax/ajax_save_predf_op.php
+++ b/include/ajax/ajax_save_predf_op.php
@@ -41,7 +41,7 @@ try {
 }
 if  ( $g_user->check_module("PREDOP") == 0) die();
 
-$prd_op=new Op_predef_SQL($cn);
+$prd_op=new Op_Predef_SQL($cn);
 $prd_op->set_pk_value($p_id);
 $prd_op->load();
 
@@ -74,4 +74,4 @@ elseif ($action == "delete")
     $xml=$operation_predef_mtable->ajax_delete();
     header('Content-type: text/xml; charset=UTF-8');
     echo $xml->saveXML();
-}
\ No newline at end of file
+}
diff --git a/include/class/extension.class.php 
b/include/class/extension.class.php
index 3ed6ad6..8021fe4 100644
--- a/include/class/extension.class.php
+++ b/include/class/extension.class.php
@@ -24,7 +24,11 @@
  * \brief the extension class manages the plugins for the security, the access
  * the inclusion...
  */
-/*!\brief manage the extension, it involves the table extension
+/*!
+ *
+ * \class Extension 
+ *
+ * \brief manage the extension, it involves the table extension
  *
  * Data member
  * - $cn database connection
diff --git a/include/class/menu_ref.class.php b/include/class/menu_ref.class.php
index 091438a..0a02e12 100644
--- a/include/class/menu_ref.class.php
+++ b/include/class/menu_ref.class.php
@@ -26,7 +26,7 @@
  *@brief Menu_Ref let you manage the available menu
  */
 require_once NOALYSS_INCLUDE.'/database/menu_ref_sql.class.php';
-class Menu_Ref extends Menu_Ref_sql
+class Menu_Ref extends Menu_Ref_SQL
 {
     function format_code()
     {
diff --git a/include/class/operation_predef_mtable.class.php 
b/include/class/operation_predef_mtable.class.php
index 8a3aea0..af62c62 100644
--- a/include/class/operation_predef_mtable.class.php
+++ b/include/class/operation_predef_mtable.class.php
@@ -17,16 +17,16 @@
  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
 // Copyright Author Dany De Bontridder danydb@aevalys.eu
-/*! \file
+/*! 
+ * \file
  * \brief Class to manage predefined operation thanks the class Manage Table
- */
-/*!
- * \brief Display a table and allow to change the predefined operation, insert 
or delete. Used the
+ * Display a table and allow to change the predefined operation, insert or 
delete. Used the
  * class Manage_Table_SQL and the SQL Object for the tables op_predef and 
op_predef_detail.
  */
 require_once NOALYSS_INCLUDE."/database/op_predef_sql.class.php";
 
 /*!
+ * \class Operation_Predef_MTable
  * \brief Display a table and allow to change the predefined operation, insert 
or delete. Used the
  * class Manage_Table_SQL and the SQL Object for the tables op_predef and 
op_predef_detail.
  * 
@@ -38,7 +38,7 @@ class Operation_Predef_MTable extends Manage_Table_SQL
 {
     private $pre_operation;
     private $force_ledger_type; //!< When adding , the ledger must be set
-    function __construct(Op_predef_SQL $p_table)
+    function __construct(Op_Predef_SQL $p_table)
     {
         parent::__construct($p_table);
 
@@ -178,4 +178,4 @@ class Operation_Predef_MTable extends Manage_Table_SQL
               $this->get_object_name(), "xx", "smallbutton", BUTTONADD));
         echo $select->input();
     }
-}
\ No newline at end of file
+}
diff --git a/include/database/forecast_category_sql.class.php 
b/include/database/forecast_category_sql.class.php
index fd7f99a..16a065a 100644
--- a/include/database/forecast_category_sql.class.php
+++ b/include/database/forecast_category_sql.class.php
@@ -26,6 +26,11 @@
  * @file
  * @brief abstract of the table public.forecast_category
  */
+/** 
+ * @class Forecast_Category_SQL
+ *
+ * @brief ORM abstract of the table public.forecast_category
+ */
 class Forecast_Category_SQL extends Table_Data_SQL
 {
 
@@ -62,4 +67,4 @@ class Forecast_Category_SQL extends Table_Data_SQL
     }
 
 
-}
\ No newline at end of file
+}
diff --git a/include/database/forecast_item_sql.class.php 
b/include/database/forecast_item_sql.class.php
index da6106c..829d8f9 100644
--- a/include/database/forecast_item_sql.class.php
+++ b/include/database/forecast_item_sql.class.php
@@ -25,6 +25,10 @@
  * @file
  * @brief abstract of the table public.forecast_item
  */
+/**
+ * @class Forecast_Item_SQL
+ * @brief ORM abstract of the table public.forecast_item
+ */
 class Forecast_Item_SQL extends Table_Data_SQL
 {
 
diff --git a/include/database/forecast_sql.class.php 
b/include/database/forecast_sql.class.php
index 705d276..82f136e 100644
--- a/include/database/forecast_sql.class.php
+++ b/include/database/forecast_sql.class.php
@@ -26,6 +26,10 @@
  * @file
  * @brief abstract of the table public.forecast
  */
+/**
+ * @class Forecast_SQL
+ * @brief ORM abstract of the table public.forecast
+ */
 class Forecast_SQL extends Table_Data_SQL
 {
 
@@ -62,4 +66,4 @@ class Forecast_SQL extends Table_Data_SQL
     }
 
 
-}
\ No newline at end of file
+}
diff --git a/include/database/form_definition_sql.class.php 
b/include/database/form_definition_sql.class.php
index dc2f6d0..5a158d2 100644
--- a/include/database/form_definition_sql.class.php
+++ b/include/database/form_definition_sql.class.php
@@ -24,6 +24,9 @@
  *
  * @file
  * @brief abstract of the table public.form_definition */
+/**
+ * @class Form_Definition_SQL
+ * @brief ORM abstract of the table public.form_definition */
 
 class Form_Definition_SQL extends \Table_Data_SQL
 {
diff --git a/include/database/form_detail_sql.class.php 
b/include/database/form_detail_sql.class.php
index 0b499de..cb268d4 100644
--- a/include/database/form_detail_sql.class.php
+++ b/include/database/form_detail_sql.class.php
@@ -24,6 +24,9 @@
  *
  * @file
  * @brief abstract of the table public.form_detail */
+ /**
+ * @class Form_Detail_SQL
+ * @brief ORM abstract of the table public.form_detail */
 class Form_Detail_SQL extends \Table_Data_SQL
 {
 
diff --git a/include/database/jrn_def_sql.class.php 
b/include/database/jrn_def_sql.class.php
index c106d71..0fb8627 100644
--- a/include/database/jrn_def_sql.class.php
+++ b/include/database/jrn_def_sql.class.php
@@ -24,6 +24,9 @@
  *
  * @file
  * @brief abstract of the table public.jrn_def */
+ /**
+ * @class Jrn_def_SQL
+ * @brief ORM abstract of the table public.jrn_def */
 class Jrn_def_SQL extends Table_Data_SQL
 {
 
diff --git a/include/database/op_predef_sql.class.php 
b/include/database/op_predef_sql.class.php
index c83e3e3..702a383 100644
--- a/include/database/op_predef_sql.class.php
+++ b/include/database/op_predef_sql.class.php
@@ -30,7 +30,7 @@
  *@brief ORM abstract of the table public.op_predef */
  
 
-class Op_predef_SQL extends Table_Data_SQL
+class Op_Predef_SQL extends Table_Data_SQL
 {
 
     function __construct(DatabaseCore $p_cn,$p_id=-1)
@@ -72,4 +72,4 @@ class Op_predef_SQL extends Table_Data_SQL
     }
 
 
-}
\ No newline at end of file
+}
diff --git a/include/database/stock_goods_sql.class.php 
b/include/database/stock_goods_sql.class.php
index 538bb7d..eeeb364 100644
--- a/include/database/stock_goods_sql.class.php
+++ b/include/database/stock_goods_sql.class.php
@@ -22,7 +22,11 @@
 
 /**
  * @file
- * @brief
+ * @brief abstract of the table public.stock_goods and public.stock_change
+ */
+/**
+ * @class Stock_Goods_Sql
+ * @brief ORM abstract of the table public.stock_goods
  *
  */
 
@@ -80,6 +84,10 @@ class Stock_Goods_Sql extends Table_Data_SQL
 
 }
 
+/**
+ * @class Stock_Change_Sql
+ * @brief ORM abstract of the table public.stock_change
+ */
 class Stock_Change_Sql extends Table_Data_SQL
 {
 
diff --git a/include/database/stock_sql.class.php 
b/include/database/stock_sql.class.php
index d5ebbb1..5ae2562 100644
--- a/include/database/stock_sql.class.php
+++ b/include/database/stock_sql.class.php
@@ -22,10 +22,15 @@
 
 /**
  * @file
- * @brief
+ * @brief abstract of the table public.stock_repository */
  *
  */
 
+ /**
+  * @class Stock_Sql
+  *
+  * @brief ORM abstract of the table public.stock_repository
+  */
 class Stock_Sql extends Table_Data_SQL {
        function __construct($cn,$p_id=-1)
        {
diff --git a/include/database/tag_group_sql.class.php 
b/include/database/tag_group_sql.class.php
index 02fe459..94ee749 100644
--- a/include/database/tag_group_sql.class.php
+++ b/include/database/tag_group_sql.class.php
@@ -25,6 +25,13 @@
  *
  *@file
  *@brief abstract of the table public.tag_group */
+
+
+/**
+ * @class Tag_group_SQL
+ * @brief ORM abstract of the table public.tag_group 
+ *
+ */
 class Tag_group_SQL extends Table_Data_SQL
 {
 
@@ -57,4 +64,4 @@ function __construct(DatabaseCore $p_cn,$p_id=-1)
   }
   
 
-}
\ No newline at end of file
+}
diff --git a/include/database/tmp_pcmn_sql.class.php 
b/include/database/tmp_pcmn_sql.class.php
index 5cd9a39..2bd1232 100644
--- a/include/database/tmp_pcmn_sql.class.php
+++ b/include/database/tmp_pcmn_sql.class.php
@@ -19,11 +19,16 @@
  */
 
 
-/* * *
+/**
  * @file 
- * @brief
+ * @brief abstract of the table public.tmp_pcmn
  *
  */
+ /**
+  * @class Tmp_Pcmn_SQL
+  *
+  * @brief ORM abstract of the table public.tmp_pcmn
+  */
 class Tmp_Pcmn_SQL extends Table_Data_SQL
 {
 
diff --git a/include/database/tva_rate_sql.class.php 
b/include/database/tva_rate_sql.class.php
index 654587b..d79e9bf 100644
--- a/include/database/tva_rate_sql.class.php
+++ b/include/database/tva_rate_sql.class.php
@@ -26,6 +26,11 @@
  * @brief abstract of the table public.tva_rate
  * 
  */
+
+/**
+ * @class Tva_rate_SQL
+ * @brief abstract of the table public.tva_rate
+ */
 class Tva_rate_SQL extends Table_Data_SQL
 {
 
diff --git a/include/database/user_filter_sql.class.php 
b/include/database/user_filter_sql.class.php
index dd855a2..71b724e 100644
--- a/include/database/user_filter_sql.class.php
+++ b/include/database/user_filter_sql.class.php
@@ -26,6 +26,11 @@
  * @file
  * @brief abstract of the table public.user_filter 
  */
+
+/** 
+ * @class User_filter_SQL
+ * @brief ORM abstract of the table public.user_filter
+ */
 class User_filter_SQL extends Table_Data_SQL
 {
 
diff --git a/include/database/v_tva_rate_sql.class.php 
b/include/database/v_tva_rate_sql.class.php
index df55838..b8df366 100644
--- a/include/database/v_tva_rate_sql.class.php
+++ b/include/database/v_tva_rate_sql.class.php
@@ -26,6 +26,10 @@
  * @brief abstract of the view public.v_tva_rate
  * 
  */
+/**
+ * @class V_Tva_Rate_SQL
+ * @brief ORM abstract of the view public.v_tva_rate
+ */
 class V_Tva_Rate_SQL extends Table_Data_SQL
 {
 
@@ -72,4 +76,4 @@ class V_Tva_Rate_SQL extends Table_Data_SQL
         parent::__construct($p_cn, $p_id);
     }
 
-}
\ No newline at end of file
+}
diff --git a/include/menu.inc.php b/include/menu.inc.php
index 6629e5f..1fa3ac8 100644
--- a/include/menu.inc.php
+++ b/include/menu.inc.php
@@ -20,7 +20,8 @@
 
 // Copyright Author Dany De Bontridder danydb@aevalys.eu
 
-/**\file
+/**
+ * \file
  *
  *
  * \brief Show the table menu and let you add your own
@@ -131,7 +132,7 @@ if ( $iselect->selected != '')
 {
        $sql="where me_type='".sql_string($_REQUEST['p_type'])."'  ";
 }
-$menu=new Menu_Ref_sql($cn);
+$menu=new Menu_Ref_SQL($cn);
 $ret=$menu->seek($sql.$order);
 ?>
 <fieldset><legend><?php echo _('Recherche')?></legend>
diff --git a/include/preod.inc.php b/include/preod.inc.php
index 899f670..0c2ca08 100644
--- a/include/preod.inc.php
+++ b/include/preod.inc.php
@@ -26,7 +26,7 @@
 if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
 global $http;
 
-$prd_op=new Op_predef_SQL($cn);
+$prd_op=new Op_Predef_SQL($cn);
 
 $operation_predef_mtable=new Operation_Predef_MTable($prd_op);
 $operation_predef_mtable->set_json(json_encode(array(   
"ac"=>$http->request("ac"),
@@ -60,4 +60,4 @@ echo '</p>';
          . " ( select jrn_def_id from jrn_def where jrn_def_type ='FIN') ");
 echo '<p>';
 $operation_predef_mtable->display_button_add();
-echo '</p>';
\ No newline at end of file
+echo '</p>';