admingit/altocompta
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Correct Doxygen documentation

Browse source
This commit is contained in:
Dany De Bontridder 2017-01-18 19:41:35 +01:00
parent 9d508e0d2b
commit bc886bbc0a
8 changed files with 32 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

39
include/class/class_acc_ledger.php
View file

@ -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()
{

2
include/class/class_acc_ledger_purchase.php
View file

@ -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

2
include/class/class_acc_ledger_sold.php
View file

@ -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

2
include/class/class_extension.php
View file

@ -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

6
include/class/class_follow_up.php
View file

@ -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)

4
include/class/class_stock_goods.php
View file

@ -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
*/

3
include/lib/class_html_input.php
View file

@ -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

6
include/lib/class_single_record.php
View file

@ -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