[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Noalyss-commit] [noalyss] 132/151: Correct Doxygen documentation
From: |
Dany De Bontridder |
Subject: |
[Noalyss-commit] [noalyss] 132/151: Correct Doxygen documentation |
Date: |
Sat, 4 Feb 2017 17:14:34 +0000 (UTC) |
sparkyx pushed a commit to branch master
in repository noalyss.
commit bc886bbc0a1f6e9956084336af33a8c321d86a39
Author: Dany De Bontridder <address@hidden>
Date: Wed Jan 18 19:41:35 2017 +0100
Correct Doxygen documentation
---
include/class/class_acc_ledger.php | 39 +++++++++++++--------------
include/class/class_acc_ledger_purchase.php | 2 +-
include/class/class_acc_ledger_sold.php | 2 +-
include/class/class_extension.php | 2 +-
include/class/class_follow_up.php | 6 ++---
include/class/class_stock_goods.php | 4 +--
include/lib/class_html_input.php | 3 ++-
include/lib/class_single_record.php | 6 ++---
8 files changed, 32 insertions(+), 32 deletions(-)
diff --git a/include/class/class_acc_ledger.php
b/include/class/class_acc_ledger.php
index 6d813f7..f8b8d81 100644
--- a/include/class/class_acc_ledger.php
+++ b/include/class/class_acc_ledger.php
@@ -358,7 +358,7 @@ class Acc_Ledger extends jrn_def_sql
return $ret['jrn_def_name'];
}
- /** \function get_row
+ /**
* @brief Get The data
*
*
@@ -1268,7 +1268,7 @@ class Acc_Ledger extends jrn_def_sql
return Database::fetch_array($Res, 0);
}
- /** \function GetDefLine
+ /**
* @brief Get the number of lines of a journal
* @param$p_cred deb or cred
*
@@ -2171,8 +2171,8 @@ class Acc_Ledger extends jrn_def_sql
/**
* @brief retrieve the next number for this type of ledger
- * @paramp_cn connx
- * @paramp_type ledger type
+ * @param p_cn connx
+ * @param p_type ledger type
*
* \return the number
*
@@ -2188,8 +2188,8 @@ class Acc_Ledger extends jrn_def_sql
/**
* @brief get the first ledger
- * @paramthe type
- * \return the j_id
+ * @param type
+ * @return the j_id
*/
public function get_first($p_type, $p_access = 3)
@@ -2201,7 +2201,7 @@ class Acc_Ledger extends jrn_def_sql
/**
* @brief Update the paiment in the list of operation
- * @param$p_array is normally $_GET
+ * @param $p_array is normally $_GET
*/
function update_paid($p_array)
@@ -2311,8 +2311,7 @@ class Acc_Ledger extends jrn_def_sql
/**
* @brief retrieve all the card for this type of ledger, make them
* into a string separated by comma
- * @paramnone
- * \return all the card or null is nothing is found
+ * @return all the card or null is nothing is found
*/
function get_all_fiche_def()
@@ -2421,7 +2420,7 @@ class Acc_Ledger extends jrn_def_sql
/**
* @brief retrieve the jr_id thanks the internal code, do not change
* anything to the current object
- * @paramthe internal code
+ * @param internal code
* \return the jr_id or 0 if not found
*/
@@ -2437,8 +2436,8 @@ class Acc_Ledger extends jrn_def_sql
/**
* @brief create the invoice and saved it as attachment to the
* operation,
- * @param$internal is the internal code
- * @param$p_array is normally the $_POST
+ * @param $internal is the internal code
+ * @param $p_array is normally the $_POST
* \return a string
*/
@@ -2465,7 +2464,7 @@ class Acc_Ledger extends jrn_def_sql
/**
* @brief check if the payment method is valid
- * @param$e_mp is the value and $e_mp_qcode is the quickcode
+ * @param $e_mp is the value and $e_mp_qcode is the quickcode
* \return nothing throw an Exception
*/
@@ -2512,12 +2511,12 @@ class Acc_Ledger extends jrn_def_sql
/**
* @brief return a HTML string with the form for the search
- * @param $p_type if the type of ledger possible
values=ALL,VEN,ACH,ODS,FIN
- * @param $all_type_ledger
+ * @param $p_type if the type of ledger possible
values=ALL,VEN,ACH,ODS,FIN
+ * @param $all_type_ledger
* values :
* - 1 means all the ledger of this type
* - 0 No have the "Tous les journaux" availables
- * @param $div is the div (for reconciliation)
+ * @param $div is the div (for reconciliation)
* @return a HTML String without the tag FORM or DIV
*
* @see build_search_sql
@@ -2651,9 +2650,9 @@ class Acc_Ledger extends jrn_def_sql
/**
* @brief this function will create a sql stmt to use to create the
list for
* the ledger,
- * @param$p_array is usually the $_GET,
- * @param$p_order the order of the row
- * @param$p_where is the sql condition if not null then the $p_array
will not be used
+ * @param $p_array is usually the $_GET,
+ * @param $p_order the order of the row
+ * @param $p_where is the sql condition if not null then the $p_array
will not be used
* \note the p_action will be used to filter the ledger but gl means ALL
* struct array $p_array
\verbatim
@@ -3799,7 +3798,7 @@ class Acc_Ledger extends jrn_def_sql
/**
* delete a ledger IF is not already used
- * @exeption : cannot delete
+ * @exception : cannot delete
*/
function delete_ledger()
{
diff --git a/include/class/class_acc_ledger_purchase.php
b/include/class/class_acc_ledger_purchase.php
index 950f78a..194bce3 100644
--- a/include/class/class_acc_ledger_purchase.php
+++ b/include/class/class_acc_ledger_purchase.php
@@ -1733,7 +1733,7 @@ EOF;
}
/**
* Retrieve data from the view v_detail_purchase
- * @global $g_user connected user
+ * @note $g_user connected user
* @param $p_from jrn.jr_tech_per from
* @param $p_end jrn.jr_tech_per to
* @return handle to database result
diff --git a/include/class/class_acc_ledger_sold.php
b/include/class/class_acc_ledger_sold.php
index bf4fada..f3aad41 100644
--- a/include/class/class_acc_ledger_sold.php
+++ b/include/class/class_acc_ledger_sold.php
@@ -1312,7 +1312,7 @@ EOF;
}
/**
* Retrieve data from the view v_detail_sale
- * @global $g_user connected user
+ * @remark $g_user connected user
* @param $p_from jrn.jr_tech_per from
* @param type $p_end jrn.jr_tech_per to
* @return type
diff --git a/include/class/class_extension.php
b/include/class/class_extension.php
index 06c3ab1..4ba9c69 100644
--- a/include/class/class_extension.php
+++ b/include/class/class_extension.php
@@ -102,7 +102,7 @@ class Extension extends Menu_Ref_sql
/**
* insert into the table profile_menu for the given profile id and
depending
* of the module $p_module
- * @global type $cn
+ * @remark type $cn
* @param type $p_id profile.p_id
* @param type $p_module menu_ref.me_code
* @throws Exception 10 : profile absent , 20 module absent , 30 No parent
menu
diff --git a/include/class/class_follow_up.php
b/include/class/class_follow_up.php
index d3a752a..9ee6d38 100644
--- a/include/class/class_follow_up.php
+++ b/include/class/class_follow_up.php
@@ -106,7 +106,7 @@ class Follow_Up
}
/**
* Create a filter based on the current user,
- * @global type $g_user Connected user
+ * @remark type $g_user Connected user
* @param type $cn Database connection
* @param type $p_mode Mode is R (for Read) or W (for write)
* @return string SQL where clause to include in the SQL
@@ -1710,7 +1710,7 @@ class Follow_Up
/**
* Add another concerned (tiers, supplier...)
- * @global type $g_user
+ * @remark type $g_user
* @param type $p_fiche_id
*/
function insert_linked_card($p_fiche_id)
@@ -1731,7 +1731,7 @@ class Follow_Up
/**
* Remove another concerned (tiers, supplier...)
- * @global type $g_user
+ * @remark type $g_user
* @param type $p_fiche_id
*/
function remove_linked_card($p_fiche_id)
diff --git a/include/class/class_stock_goods.php
b/include/class/class_stock_goods.php
index 6378e09..25857c5 100644
--- a/include/class/class_stock_goods.php
+++ b/include/class/class_stock_goods.php
@@ -37,7 +37,7 @@ class Stock_Goods extends Stock_Goods_Sql
* sg_codeX
* sg_type0
*
- * @global $cn database connx
+ * @remark $cn database connx
* @param $p_array
* if an array if receive the keys are
* p_date
@@ -214,7 +214,7 @@ class Stock_Goods extends Stock_Goods_Sql
}
/**
* Return an array, used by Stock_Goods::input
- * @global type $cn
+ * @remark type $cn
* @param type $p_array
* @throws Exception
*/
diff --git a/include/lib/class_html_input.php b/include/lib/class_html_input.php
index d8915e3..3b64d9a 100755
--- a/include/lib/class_html_input.php
+++ b/include/lib/class_html_input.php
@@ -788,7 +788,8 @@ class HtmlInput
/**
*Create an ISelect object containing the available repository for
reading
* or writing
- * @global $g_user
+ * @remark $g_user global.
+ *
* @param $p_cn db object
* @param $p_name name of the select
* @param $p_mode is 'R' for reading, 'W' for writinh
diff --git a/include/lib/class_single_record.php
b/include/lib/class_single_record.php
index 4db8d80..dd493d0 100644
--- a/include/lib/class_single_record.php
+++ b/include/lib/class_single_record.php
@@ -36,7 +36,7 @@ class Single_Record
/**
* Constructor $p_name will be set to $this->name, it is also the name
* of the tag hidden in a form
- * @global $cn Db connxion
+ * @remark $cn Db connexion
* @param $p_name
*/
function __construct($p_name)
@@ -56,7 +56,7 @@ class Single_Record
}
/**
* @brief Try to insert into the table Single_Record
- * @global $cn Database connx
+ * @remark global $cn Database connexion
* @throws Exception if the value $p_id is not unique
*/
function save($p_array=null)
@@ -74,7 +74,7 @@ class Single_Record
}
/**
* Count how many time we have this->id into the table tool_uos
- * @global $cn Database connx
+ * @remark global $cn Database connexion
* @param $p_array is the array where to find the key name, usually it is
* $_POST. The default value is $_POST
* @return integer : 0 or 1
- [Noalyss-commit] [noalyss] 83/151: Performance : improve VERIF, (continued)
- [Noalyss-commit] [noalyss] 83/151: Performance : improve VERIF, Dany De Bontridder, 2017/02/04
- [Noalyss-commit] [noalyss] 74/151: Export en PDF d'operation : PDF_Operation::print_section Task #10 - PDF_Operation : ajout titre Analytique, Dany De Bontridder, 2017/02/04
- [Noalyss-commit] [noalyss] 84/151: Performance : improve VERIF , change query pour fiche utilisé avec 2 postes, Dany De Bontridder, 2017/02/04
- [Noalyss-commit] [noalyss] 115/151: Correct doxygen, Dany De Bontridder, 2017/02/04
- [Noalyss-commit] [noalyss] 109/151: Add a class to manage the Param table (CRUD), Dany De Bontridder, 2017/02/04
- [Noalyss-commit] [noalyss] 113/151: Correct doxygen doc, Dany De Bontridder, 2017/02/04
- [Noalyss-commit] [noalyss] 131/151: Doxygen, Dany De Bontridder, 2017/02/04
- [Noalyss-commit] [noalyss] 120/151: Add managetable.js to the script to load, Dany De Bontridder, 2017/02/04
- [Noalyss-commit] [noalyss] 128/151: Security : add security, Dany De Bontridder, 2017/02/04
- [Noalyss-commit] [noalyss] 130/151: #1380 : change the name of the function Acc_Ledger::button_copy_operation, Dany De Bontridder, 2017/02/04
- [Noalyss-commit] [noalyss] 132/151: Correct Doxygen documentation,
Dany De Bontridder <=
- [Noalyss-commit] [noalyss] 96/151: Documentation and clean code, Dany De Bontridder, 2017/02/04
- [Noalyss-commit] [noalyss] 112/151: Improve Doxygen doc, Dany De Bontridder, 2017/02/04
- [Noalyss-commit] [noalyss] 73/151: Export en PDF d'operation, Dany De Bontridder, 2017/02/04
- [Noalyss-commit] [noalyss] 143/151: Fix : when exporting files for creating a PDF in ANC , the filename can be a problem if he contains some char., Dany De Bontridder, 2017/02/04
- [Noalyss-commit] [noalyss] 116/151: Manage_Table , the js and php code are been splitted in 2 files , the ajax calls are nearly done , doxygen for these files is correct, Dany De Bontridder, 2017/02/04
- [Noalyss-commit] [noalyss] 101/151: Deprecated HtmlInput::make_object must be replace by json_encode, Dany De Bontridder, 2017/02/04
- [Noalyss-commit] [noalyss] 99/151: Improve Sorttable, Dany De Bontridder, 2017/02/04
- [Noalyss-commit] [noalyss] 110/151: Add property in Manage_Table VISIBLE UPDATABLE, Dany De Bontridder, 2017/02/04
- [Noalyss-commit] [noalyss] 125/151: Test ManageTable ; fix parseXML function, Dany De Bontridder, 2017/02/04
- [Noalyss-commit] [noalyss] 144/151: Merge branch 'master' of ns3:/srv/git/noalyss, Dany De Bontridder, 2017/02/04