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

Doxygen does not allow to document javascript

Browse source 
Remove tag for using with jsdoc
This commit is contained in:
Dany De Bontridder 2019-07-27 17:53:59 +02:00
parent 54f8bb1d4b
commit 9a483f19c3
6 changed files with 69 additions and 69 deletions
Download patch file Download diff file Expand all files Collapse all files

58
html/js/acc_ledger.js
View file

@ -26,7 +26,7 @@
*/
var layer = 1;
/**
* @brief update the list of available predefined operation when we change the ledger.
* update the list of available predefined operation when we change the ledger.
*/
function update_predef(p_type, p_direct, p_ac)
{
@ -64,7 +64,7 @@ function update_predef(p_type, p_direct, p_ac)
}
/**
* @brief update the list of payment method when we change the ledger.
* update the list of payment method when we change the ledger.
*/
function update_pay_method()
{
@ -88,7 +88,7 @@ function update_pay_method()
}
/**
*@brief update ctl id =jrn_name with the value of p_jrn
* update ctl id =jrn_name with the value of p_jrn
*/
function update_name()
{
@ -109,7 +109,7 @@ function update_name()
}
/**
* @brief update the field predef
* update the field predef
*/
function error_get_predef(request, json)
{
@ -117,7 +117,7 @@ function error_get_predef(request, json)
}
/**
* @brief update the list of available predefined operation when we change the ledger.
* update the list of available predefined operation when we change the ledger.
*/
function update_pj()
{
@ -135,7 +135,7 @@ function update_pj()
);
}
/**
*@brief ask the name, quick_code of the bank for the ledger
* ask the name, quick_code of the bank for the ledger
*/
function update_bank()
{
@ -154,7 +154,7 @@ function update_bank()
}
/**
* @brief Update the number of rows when changing of ledger
* Update the number of rows when changing of ledger
*/
function update_row(ctl)
{
@ -211,7 +211,7 @@ function update_row(ctl)
}
}
/**
* @brief Put into the span, the name of the bank, the bank account
* Put into the span, the name of the bank, the bank account
* and the quick_code
*/
function success_update_bank(req)
@ -237,7 +237,7 @@ function success_update_bank(req)
}
}
/**
* @brief call ajax, ask what is the last date for the current ledger
* call ajax, ask what is the last date for the current ledger
*/
function get_last_date()
{
@ -255,7 +255,7 @@ function get_last_date()
);
}
/**
* @brief callback ajax, set the ctl with the last date from the ledger
* callback ajax, set the ctl with the last date from the ledger
*/
function success_get_last_date(req)
{
@ -280,7 +280,7 @@ function success_get_last_date(req)
}
}
/**
* @brief update the field predef
* update the field predef
*/
function success_get_pj(request, json)
{
@ -294,7 +294,7 @@ function success_get_pj(request, json)
g("e_pj_suggest").value = answer.pj;
}
/**
* @brief update the field predef
* update the field predef
*/
function error_get_pj(request, json)
{
@ -302,7 +302,7 @@ function error_get_pj(request, json)
}
/**
* @brief add a line in the form for the ledger fin
* add a line in the form for the ledger fin
*/
function ledger_fin_add_row()
{
@ -345,7 +345,7 @@ function ledger_fin_add_row()
}
/**
* @brief add a line in the form for the purchase ledger
* add a line in the form for the purchase ledger
* @param p_dossier folder id
* @param p_table_name
*/
@ -389,7 +389,7 @@ function ledger_add_row()
}
}
/**
* @brief compute the sum of a purchase, update the span tvac, htva and tva
* compute the sum of a purchase, update the span tvac, htva and tva
* all the needed data are taken from the document (hidden field : gdossier)
* @param the number of the changed ctrl
*/
@ -444,7 +444,7 @@ function compute_ledger(p_ctl_nb)
);
}
/**
*@brief refresh the purchase screen, recompute vat, total...
* refresh the purchase screen, recompute vat, total...
*/
function refresh_ledger()
{
@ -470,7 +470,7 @@ function refresh_ledger()
g('tvac').innerHTML = Math.round(tvac * 100) / 100;
}
/**
*@brief update the field htva, tva_id and tvac, callback function for compute_sold
* update the field htva, tva_id and tvac, callback function for compute_sold
* it the field TVA in the answer contains NA it means that VAT is appliable and then do not
* update the VAT field except htva_martc
*/
@ -515,7 +515,7 @@ function success_compute_ledger(request, json)
}
/**
* @brief callback error function for compute_sold
* callback error function for compute_sold
*/
function error_compute_ledger(request, json)
{
@ -591,7 +591,7 @@ function clean_ledger(p_ctl_nb)
}
/**
* @brief add a line in the form for the quick_writing
* add a line in the form for the quick_writing
*/
function quick_writing_add_row()
{
@ -651,7 +651,7 @@ function go_next_concerned()
return true;
}
/**
* @brief View the history of an account
* View the history of an account
* @param {type} p_value
* @param {type} dossier
* @returns {undefined}
@ -683,7 +683,7 @@ function view_history_account(p_value, dossier,p_exercice)
}
/**
* @brief View the history of an account
* View the history of an account
* @param {type} p_value
* @param {type} dossier
* @returns {undefined}
@ -715,7 +715,7 @@ function view_history_anc_account(p_value, dossier,p_exercice)
}
/**
* @brief Change the view of account history
* Change the view of account history
* @param {type} obj
* @returns {Boolean}
*/
@ -788,7 +788,7 @@ function view_history_card(p_value, dossier,p_exercice)
);
}
/**
* @brief update history view after changing the exercice
* update history view after changing the exercice
* @param {type} obj
* @returns {Boolean}
*/
@ -951,7 +951,7 @@ function dropLink(p_dossier, p_div, p_jr_id, p_jr_id2)
);
}
/**
*@brief this function is called before the querystring is send to the
* this function is called before the querystring is send to the
* fid2.php, add a filter based on the ledger 'p_jrn'
*@param obj is the input field
*@param queryString is the queryString to modify
@ -972,7 +972,7 @@ function filter_card(obj, queryString)
return queryString;
}
/**
*@brief to display the lettering for the operation, call
* to display the lettering for the operation, call
* ajax function
*@param obj object attribut : gDossier,j_id,obj_type
*/
@ -1082,7 +1082,7 @@ function search_letter(obj)
}
}
/**
*@brief save an operation in ajax, it concerns only the
* save an operation in ajax, it concerns only the
* comment, the pj and the rapt
* the form elements are access by their name
*@param obj form
@ -1205,7 +1205,7 @@ function show_reconcile(p_div, p_let)
}
/**
* @brief add a line in the form for the purchase ledger
* add a line in the form for the purchase ledger
*/
function gestion_add_row()
{
@ -1268,7 +1268,7 @@ function document_remove(p_dossier,p_div,p_jrid)
});
}
/***
* @brief receive an object and display a list of filter + form to save one
* receive an object and display a list of filter + form to save one
* fill up the span (id : {div}search_filter_span) with the name of the selected filter
* Object = '{'div':'','type':'ALL','all_type':1,'dossier':'10104'}'
* @see Acc_Ledger_Search
@ -1401,7 +1401,7 @@ function load_filter(p_div,p_dossier,p_filter_id) {
});
}
/**
* @brief delete a saved search filter from the db, it is limited to the current
* delete a saved search filter from the db, it is limited to the current
* user
* @parameter p_div
identification des elements LI manageli{div}_{filter_id}

8
html/js/accounting_item.js
View file

@ -40,7 +40,7 @@ function set_jrn_parent(p_ctl,p_value)
}
}
/**
*@brief show the popup for search an accounting item
* show the popup for search an accounting item
*@param object this, it must contains some attribute as
* - jrn if set and different to 0, will filter the accounting item for a
* ledger
@ -136,7 +136,7 @@ function search_poste(obj)
}
}
/**
*@brief when you submit the form for searching a accounting item
* when you submit the form for searching a accounting item
*@param obj form
*@note the same as search_poste, except it answer to a FORM and not
* to a click event
@ -194,7 +194,7 @@ function search_get_poste(obj)
}
/**
*@brief show the answer of ajax request
* show the answer of ajax request
*@param answer in XML
*/
function result_poste_search(req)
@ -231,7 +231,7 @@ function result_poste_search(req)
}
/**
*@brief error for ajax
* error for ajax
*/
function errorPoste()
{

2
html/js/admin.js
View file

@ -17,7 +17,7 @@
*/
/**
* @file
* @brief contains the javascript for the administration page
* contains the javascript for the administration page
*/
/**
* Display the forbidden folders if the request comes from a form

10
html/js/anc_script.js
View file

@ -21,7 +21,7 @@
/**
* @file
* @brief javascript for the analytic accountancy
* javascript for the analytic accountancy
*/
/*!\brief add a row for the CA
@ -322,7 +322,7 @@ function caod_checkTotal()
}
/**
*@brief remove an operation
* remove an operation
*@param p_dossier is the folder
*@param p_oa_group is the group of the analytic operation
*/
@ -378,7 +378,7 @@ function anc_add_row(tableid)
nb.value++;
}
/**
*@brief this function is called before the querystring is send to the
* this function is called before the querystring is send to the
* fid2.php, add a filter based on the ledger 'p_jrn'
*@param obj is the input field
*@param queryString is the queryString to modify
@ -391,7 +391,7 @@ function filter_anc(obj, queryString)
return queryString;
}
/**
* @brief compute and display Analytic activity, related to the choosen distribution key
* compute and display Analytic activity, related to the choosen distribution key
* @param p_dossier is the dossier id
* @param p_table is table id to replace
* @param p_amount is the amount to distribute
@ -440,7 +440,7 @@ function anc_key_compute(p_dossier, p_table, p_amount, p_key_id)
}
}
/**
* @brief choose the distribution key
* choose the distribution key
* in ajax, a window let you choose what key you want to use
*
* @param p_dossier is the dossier

34
html/js/card.js
View file

@ -25,7 +25,7 @@
var card_layer=1;
/**
*@brief search a card an display the result into a inner box
* search a card an display the result into a inner box
*/
function boxsearch_card(p_dossier)
{
@ -55,7 +55,7 @@ function boxsearch_card(p_dossier)
}
}
/**
*@brief show the ipopup with the form to search a card
* show the ipopup with the form to search a card
* the properties
* - jrn for the ledger
* - fs for the action
@ -122,7 +122,7 @@ function search_card(obj)
}
}
/**
*@brief Display form for select card to add to action : other_concerned
* Display form for select card to add to action : other_concerned
*action_add_concerned_card
*/
function action_add_concerned_card(obj)
@ -224,7 +224,7 @@ function action_add_concerned_card(obj)
}
/**
*@brief when you submit the form for searching a card
* when you submit the form for searching a card
*@param obj form
*@note the same as search_card, except it answer to a FORM and not
* to a click event
@ -285,7 +285,7 @@ function search_get_card(obj)
);
}
/**
*@brief show the answer of ajax request
* show the answer of ajax request
*@param answer in XML
*/
function result_card_search(req)
@ -399,7 +399,7 @@ function update_value(text,li)
ajaxFid(text);
}
/**
*@brief is called when something change in ICard
* is called when something change in ICard
*@param the input field
*@see ICard
*/
@ -409,7 +409,7 @@ function fill_data_onchange(ctl)
}
/**
*@brief is called when something change in ICard
* is called when something change in ICard
*@param the input field
*@see ICard
*/
@ -419,7 +419,7 @@ function fill_data(text,li)
}
/**
*@brief is called when something change in ICard
* is called when something change in ICard
*@param the input field
*@see ICard
*/
@ -429,7 +429,7 @@ function fill_fin_data_onchange(ctl)
ajax_saldo(ctl.id);
}
/**
*@brief is called when something change in ICard
* is called when something change in ICard
*@param the input field
*@see ICard
*/
@ -439,7 +439,7 @@ function fill_fin_data(text,li)
ajax_saldo($(text.id));
}
/**
*@brief show the ipopup window and display the details of a card,
* show the ipopup window and display the details of a card,
* to work some attribute must be set
*@param obj.qcode is the qcode, obj.nohistory if you don't want to display
* the history button, obj.ro is the popin is readonly
@ -498,7 +498,7 @@ function fill_ipopcard(obj)
);
}
/**
*@brief
*
* \param request : object request
* \param json : json answer
\code
@ -537,7 +537,7 @@ function successFill_ipopcard(req,json)
}
}
/**
*@brief show the ipopup for selecting a card type, it is a needed step before adding
* show the ipopup for selecting a card type, it is a needed step before adding
* a card
*@param input field (obj) it must have the attribute ipopup
* possible attribute :
@ -628,7 +628,7 @@ function select_card_type(obj)
);
}
/**
*@brief Show a blank card
* Show a blank card
*@param obj Form object (obj)
* possible attribute :
* - filter is the filter but with a fd_id list, -1 means there is no filter
@ -717,7 +717,7 @@ function form_blank_card(obj)
}
/**
*@brief save the data contained into the form 'save_card'
* save the data contained into the form 'save_card'
*@param input field (obj) it must have the attribute ipopup
* possible attribute :
*@see ajax_card.php
@ -782,7 +782,7 @@ function save_card(obj)
);
}
/**
*@brief add a category of card,
* add a category of card,
*@param obj with the attribute
* - ipopup the ipopup to show
* - type_cat the category of card we want to add
@ -828,7 +828,7 @@ function add_category(obj)
}
/**
* @brief save the form and add a new category of card
* save the form and add a new category of card
* @param obj if the form object
*/
function save_card_category(obj)
@ -864,7 +864,7 @@ function save_card_category(obj)
return false;
}
/**
*@brief Remove a definition of an attribut
* Remove a definition of an attribut
*@param attr_def.ad_id
*@param gDossier
*@param table_id to rm the row

26
html/js/gestion.js
View file

@ -27,7 +27,7 @@
/**
*@brief remove an attached document of an action
* remove an attached document of an action
*@param dossier
*@param dt_id id of the document (pk document:d_id)
*/
@ -54,7 +54,7 @@ function remove_document(p_dossier,p_id)
/**
*@brief remove the concerned operation of an action
* remove the concerned operation of an action
*@param dossier
*@param p_id id pk action_comment_operation
*/
@ -95,7 +95,7 @@ function successRemoveOp(request,json)
}
}
/**
*@brief remove the concerned operation of an action
* remove the concerned operation of an action
*@param dossier
*@param p_id id pk action_comment_operation
*/
@ -132,7 +132,7 @@ function remove_action(p_dossier,p_id,ag_id)
}
/**
*@brief remove comment of an action
* remove comment of an action
*@param dossier
*@param p_id pk action_gestion_comment
*/
@ -169,14 +169,14 @@ function successRemoveComment(request,json)
}
/**
*@brief error if a document if removed
* error if a document if removed
*/
function errorRemoveDoc()
{
alert_box('Impossible d\'effacer ce document');
}
/**
*@brief success when removing a document
* success when removing a document
*/
function successRemoveDoc(request,json)
{
@ -192,7 +192,7 @@ function successRemoveDoc(request,json)
}
/**
* @brief check the format of the hour
* check the format of the hour
* @param p_ctl is the control where the hour is encoded
*/
function check_hour(p_ctl)
@ -211,7 +211,7 @@ function check_hour(p_ctl)
}
/**
*@brief remove an attached document of an action
* remove an attached document of an action
*@param dossier
*@param dt_id id of the document (pk document:d_id)
*/
@ -240,14 +240,14 @@ function removeStock(s_id,p_dossier)
});
}
/**
*@brief error if a document if removed
* error if a document if removed
*/
function errorRemoveStock()
{
alert_box('Impossible d\'effacer ');
}
/**
*@brief success when removing a document
* success when removing a document
*/
function successRemoveStock(request,json)
{
@ -267,7 +267,7 @@ function successRemoveStock(request,json)
}
}
/**
* @brief display details of the last actions in management
* display details of the last actions in management
* called from dashboard
* @param p_dossier : dossier id
*/
@ -293,7 +293,7 @@ function action_show(p_dossier)
}
}
/**
* @brief Display a box for adding a new event
* Display a box for adding a new event
* @param {type} p_dossier
* @returns {undefined}
*/
@ -323,7 +323,7 @@ function action_add(p_dossier) {
}
}
/**
* @brief The new event is entered into the div action_add_div, we try
* The new event is entered into the div action_add_div, we try
* to save and receive as answer a XML file with a code of success and possibly
* a message
* If the message is OK then the div is fading out, otherwise the reason of