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

Improve Doxygen documentation

Browse source
This commit is contained in:
Dany De Bontridder 2017-12-18 23:48:43 +01:00
parent 088905bff3
commit 6909f2fa2b
47 changed files with 206 additions and 58 deletions
Download patch file Download diff file Expand all files Collapse all files

3
include/ajax/ajax_accounting.php
View file

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

5
include/ajax/ajax_action_remove_concerned.php
View file

@ -20,7 +20,10 @@
// Copyright 2014 Author Dany De Bontridder danydb@aevalys.eu
if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
/**
*@file
*@brief remove concerned operation , call from follow up
*/
require_once NOALYSS_INCLUDE.'/lib/http_input.class.php';
$http=new HttpInput();
try

4
include/ajax/ajax_action_save_concerned.php
View file

@ -18,6 +18,10 @@
*/
// Copyright 2014 Author Dany De Bontridder danydb@aevalys.eu
/**
*@file
*@brief insert concerned operation , call from follow up
*/
// require_once '.php';
if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis');

4
include/ajax/ajax_add_concerned_card.php
View file

@ -20,6 +20,10 @@
// Copyright 2014 Author Dany De Bontridder danydb@aevalys.eu
// require_once '.php';
/**
*@file
*@brief insert concerned operation , call from follow up
*/
if (!defined('ALLOWED'))
die('Appel direct ne sont pas permis');

20
include/ajax/ajax_anc_key_compute.php
View file

@ -18,14 +18,18 @@
*/
// Copyright 2014 Author Dany De Bontridder danydb@aevalys.eu
// @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';

5
include/ajax/ajax_anc_plan.php
View file

@ -19,7 +19,10 @@
*/
// Copyright Author Dany De Bontridder dany@alchimerys.be
///\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');

7
include/ajax/ajax_auto_anc_card.php
View file

@ -1,7 +1,10 @@
<?php
//This file is part of NOALYSS and is under GPL
//see licence.txt
/**
*@file
*@brief 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

4
include/ajax/ajax_calendar_zoom.php
View file

@ -17,6 +17,10 @@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
// Copyright Author Dany De Bontridder danydb@aevalys.eu
/**
*@file
*@brief 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';

4
include/ajax/ajax_create_menu.php
View file

@ -1,6 +1,10 @@
<?php
//This file is part of NOALYSS and is under GPL
//see licence.txt
/**
*@file
*@brief Menu creation
*/
if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
require_once NOALYSS_INCLUDE.'/class/menu_ref.class.php';

7
include/ajax/ajax_display_letter.php
View file

@ -19,7 +19,12 @@
*/
// Copyright 2015 Author Dany De Bontridder danydb@aevalys.eu
// require_once '.php';
/**
*@file
*@brief show the lettered operation
*/
if (!defined('ALLOWED'))
die('Appel direct ne sont pas permis');

1
include/ajax/ajax_display_submenu.php
View file

@ -19,6 +19,7 @@
// Copyright 2015 Author Dany De Bontridder danydb@aevalys.eu
/**
* @file
* @brief call from ajax : display submenu
* Security : only user with the menu CFGPRO
* display the submenu of a menu or a module

2
include/ajax/ajax_get_menu_detail.php
View file

@ -22,7 +22,7 @@
/**
* @file
* @brief
* @brief get detail of a menu
*
*/
// retrieve data

1
include/ajax/ajax_ledger_show.php
View file

@ -3,6 +3,7 @@
//see licence.txt
/**
*@file
* @brief
* Show a div for selecting ledger
* return a html code for creating a window

2
include/ajax/ajax_min_row.php
View file

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

4
include/ajax/ajax_mod_menu.php
View file

@ -1,6 +1,10 @@
<?php
//This file is part of NOALYSS and is under GPL
//see licence.txt
/**
*@file
*@brief Menu modification
*/
if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
require_once NOALYSS_INCLUDE.'/class/menu_ref.class.php';

5
include/ajax/ajax_navigator.php
View file

@ -19,6 +19,11 @@
*/
// Copyright Author Dany De Bontridder dany@alchimerys.be
/**
*@file
*@brief display the navigator
*/
if ( ! defined ('ALLOWED')) die('Appel direct ne sont pas permis');
echo HtmlInput::title_box(_("Navigateur"), "navi_div");
$sql="

6
include/ajax/ajax_remove_submenu.php
View file

@ -18,8 +18,12 @@
*/
// Copyright 2015 Author Dany De Bontridder danydb@aevalys.eu
/**
*@file
*@brief remove a submenu
*/
// require_once '.php';
if ( ! defined ('ALLOWED') ) die(_('Non autorisé'));
require_once NOALYSS_INCLUDE.'/lib/http_input.class.php';
$http=new HttpInput();

5
include/ajax/ajax_search_add_tag.php
View file

@ -18,6 +18,11 @@
*/
// Copyright Author Dany De Bontridder danydb@aevalys.eu
if ( !defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
/**
*@file
*@brief add tag , used for follow up
*@see Tag
*/
require_once NOALYSS_INCLUDE.'/class/tag.class.php';
ob_start();

5
include/ajax/ajax_search_clear_tag.php
View file

@ -18,6 +18,11 @@
*/
// Copyright Author Dany De Bontridder danydb@aevalys.eu
if ( !defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
/**
*@file
*@brief remove tag , call from follow up
*@see Tag
*/
require_once NOALYSS_INCLUDE.'/class/tag.class.php';
ob_start();

5
include/ajax/ajax_search_display_tag.php
View file

@ -18,6 +18,11 @@
*/
// Copyright Author Dany De Bontridder danydb@aevalys.eu
if ( !defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
/**
*@file
*@brief remove tag , call from follow up
*@see Tag
*/
require_once NOALYSS_INCLUDE.'/class/tag.class.php';
ob_start();

6
include/ajax/ajax_tag_add_action.php
View file

@ -18,6 +18,12 @@
*/
// Copyright Author Dany De Bontridder danydb@aevalys.eu
if ( !defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
/**
*@file
*@brief remove tag , call from follow up
*@see Follow_Up
*@see Tag
*/
$fl=new Follow_Up($cn);
$fl->ag_id=$_REQUEST['ag_id'];

1
include/ajax/ajax_tag_detail.php
View file

@ -1,5 +1,6 @@
<?php
/**
*@file
* @brief display a window with the content of a tag
*/
//This file is part of NOALYSS and is under GPL

4
include/ajax/ajax_tag_list.php
View file

@ -17,6 +17,10 @@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
// Copyright Author Dany De Bontridder danydb@aevalys.eu
/**
*@file
*@brief Display the list of tags
*/
if ( !defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
require_once NOALYSS_INCLUDE.'/class/tag.class.php';

4
include/ajax/ajax_tag_remove_action.php
View file

@ -17,6 +17,10 @@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
// Copyright Author Dany De Bontridder danydb@aevalys.eu
/**
*@file
*@brief 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);

6
include/ajax/ajax_tag_save.php
View file

@ -1,7 +1,11 @@
<?php
//This file is part of NOALYSS and is under GPL
//see licence.txt
/**
*@file
*@brief save a new tag
*@see Tag
*/
if ( !defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
require_once NOALYSS_INCLUDE.'/class/tag.class.php';

6
include/ajax/ajax_tag_select_search.php
View file

@ -18,7 +18,11 @@
*/
// Copyright Author Dany De Bontridder danydb@aevalys.eu
if ( !defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
/**
*@file
*@brief Show the tags to select
*@see Tag
*/
require_once NOALYSS_INCLUDE.'/class/tag.class.php';
ob_start();
$tag=new Tag($cn);

5
include/anc_acc_balance.inc.php
View file

@ -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">';

6
include/anc_acc_table.inc.php
View file

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

6
include/anc_balance_double.inc.php
View file

@ -1,7 +1,11 @@
<?php
//This file is part of NOALYSS and is under GPL
//see licence.txt
/**
*@file
*@brief Print the crossed balance between 2 plan
*@see 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);

6
include/anc_balance_simple.inc.php
View file

@ -1,7 +1,11 @@
<?php
//This file is part of NOALYSS and is under GPL
//see licence.txt
/**
*@file
*@brief 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);

6
include/anc_great_ledger.inc.php
View file

@ -1,7 +1,11 @@
<?php
//This file is part of NOALYSS and is under GPL
//see licence.txt
/**
*@file
*@brief 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;

6
include/anc_group_balance.inc.php
View file

@ -1,7 +1,11 @@
<?php
//This file is part of NOALYSS and is under GPL
//see licence.txt
/**
*@file
*@brief 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';

6
include/anc_history.inc.php
View file

@ -2,7 +2,11 @@
//This file is part of NOALYSS and is under GPL
//see licence.txt
/**
*@file
*@brief 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';

4
include/anc_pa.inc.php
View file

@ -20,9 +20,9 @@
// Copyright Author Dany De Bontridder danydb@aevalys.eu
/* !\file
/*!\file
*
* \brief Plan Analytique
*\brief Plan Analytique
*
*/
if (!defined('ALLOWED'))

7
include/balance_age.inc.php
View file

@ -21,11 +21,10 @@
if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
global $http;
/**
* @file
* @brief
* @param type $name Descriptionara
*@file
*@brief Print the aged balance for accountancy see
* @see Balance_Age
*/
$type=$http->get('p_type','string','C');
$let=$http->get('p_let','string','unlet');

4
include/balance_card_ageing.inc.php
View file

@ -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
*@see Balance_Age
*/
require_once NOALYSS_INCLUDE.'/class/exercice.class.php';
require_once NOALYSS_INCLUDE.'/class/balance_age.class.php';

2
include/cat_document.inc.php
View file

@ -20,7 +20,7 @@
// Copyright Author Dany De Bontridder danydb@aevalys.eu
/* !\file
/*!\file
* \brief this file is included to perform modification on category of document
* table document_type
*/

2
include/category_card.inc.php
View file

@ -20,7 +20,7 @@
// Copyright Author Dany De Bontridder danydb@aevalys.eu
/* !\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

15
include/class/anc_balance_double.class.php
View file

@ -19,15 +19,11 @@
// Copyright Author Dany De Bontridder danydb@aevalys.eu
/*!\file
* \brief
* Print the crossed balance between 2 plan
/**
*@file
*@brief 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
{

4
include/dashboard.inc.php
View file

@ -1,5 +1,9 @@
<?php
if ( ! defined ('ALLOWED') ) die('Appel direct ne sont pas permis');
/**
*@file
*@brief Dashboard
*/
require_once NOALYSS_INCLUDE.'/lib/idate.class.php';
require_once NOALYSS_INCLUDE.'/lib/itext.class.php';
require_once NOALYSS_INCLUDE.'/constant.php';

9
include/lib/filetosend.class.php
View file

@ -18,11 +18,20 @@
*/
// Copyright Author Dany De Bontridder danydb@aevalys.eu
/**
*@file
* @brief file to add to a message
*
* @see Sendmail
* @author dany
*/
/**
* @brief file to add to a message
*
* @see Sendmail
* @author dany
*/
class FileToSend
{
/**

11
include/lib/http_input.class.php
View file

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

17
include/lib/icard.class.php
View file

@ -20,12 +20,12 @@
// Copyright Author Dany De Bontridder danydb@aevalys.eu
/* !\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()
{

6
include/lib/idate.class.php
View file

@ -20,8 +20,10 @@
// Copyright Author Dany De Bontridder danydb@aevalys.eu
///!\file
//\brief Html Input
/**
*\file
\brief Html Input
*/
/// Html Input : Input a date format dd.mm.yyyy

7
include/lib/noalyss_csv.class.php
View file

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

3
include/lib/pdf.class.php
View file

@ -20,7 +20,8 @@
// Copyright Author Dany De Bontridder danydb@aevalys.eu
/*!\file
* \brief
* \brief API for creating PDF, unicode, based on tfpdf
*@see TFPDF
*/
require_once NOALYSS_INCLUDE.'/tfpdf/tfpdf.php';

6
include/lib/sendmail.class.php
View file

@ -18,9 +18,13 @@
*/
// Copyright Author Dany De Bontridder danydb@aevalys.eu
/**
*@file
*@brief API for sending email
*/
/**
* Description of class_sendmail
* Description of Sendmail
*
* @author dany
*/