diff --git a/include/action.common.inc.php b/include/action.common.inc.php index 9c5a25e47..bb2f7ebe3 100644 --- a/include/action.common.inc.php +++ b/include/action.common.inc.php @@ -45,7 +45,7 @@ $correction = 0; $error_id=0; /*-----------------------------------------------------------------------------*/ -/* For other action +/* For other action */ /*-----------------------------------------------------------------------------*/ if ( isset ($_POST['other_action_bt'])) { /** diff --git a/include/class/acc_currency.class.php b/include/class/acc_currency.class.php index 21e4eb3a2..bd58afe45 100644 --- a/include/class/acc_currency.class.php +++ b/include/class/acc_currency.class.php @@ -26,7 +26,7 @@ require_once NOALYSS_INCLUDE."/database/v_currency_last_value_sql.class.php"; */ /** - * @class + * @class Acc_Currency * @brief display currency , convert to euro , and save them if used. The default currency has the id 0 and is * normally EUR */ diff --git a/include/class/acc_ledger_fin.class.php b/include/class/acc_ledger_fin.class.php index 36ec0cdd3..a0163f9b4 100644 --- a/include/class/acc_ledger_fin.class.php +++ b/include/class/acc_ledger_fin.class.php @@ -20,10 +20,16 @@ // Copyright Author Dany De Bontridder danydb@aevalys.eu -/* * \file +/** + * \file * \brief the class Acc_Ledger_Fin inherits from Acc_Ledger, this * object permit to manage the financial ledger */ + /** + * \class Acc_Ledger_Fin + * \brief the class Acc_Ledger_Fin inherits from Acc_Ledger, this + * object permit to manage the financial ledger + */ require_once NOALYSS_INCLUDE.'/lib/ac_common.php'; class Acc_Ledger_Fin extends Acc_Ledger @@ -36,8 +42,7 @@ class Acc_Ledger_Fin extends Acc_Ledger } /** - * Verify that the data are correct before inserting or confirming - * @brief verify the data + * @brief Verify that the data are correct before inserting or confirming * @param an array (usually $_POST) * @return String * @throw Exception on error occurs @@ -227,7 +232,8 @@ class Acc_Ledger_Fin extends Acc_Ledger } } - /* * \brief + /** + * \brief display a form to enter an FIN operation * \param $p_array contains the value usually it is $_POST * \return string with html code * \note the form tag are not set here diff --git a/include/class/acc_ledger_history_financial.class.php b/include/class/acc_ledger_history_financial.class.php index babae58cb..5047d59aa 100644 --- a/include/class/acc_ledger_history_financial.class.php +++ b/include/class/acc_ledger_history_financial.class.php @@ -25,7 +25,11 @@ * @brief display financial operations in HTML , PDF or CSV * */ - +/** + * @class Acc_Ledger_History_Financial + * @brief display financial operations in HTML , PDF or CSV + * + */ class Acc_Ledger_History_Financial extends Acc_Ledger_History { function __construct(Database $cn, $pa_ledger, $p_from, $p_to, $p_mode) diff --git a/include/class/acc_ledger_search.class.php b/include/class/acc_ledger_search.class.php index e21183a9b..33d98384f 100644 --- a/include/class/acc_ledger_search.class.php +++ b/include/class/acc_ledger_search.class.php @@ -26,6 +26,10 @@ * @file * @brief search in ledger */ +/** + * @class Acc_Ledger_Search + * @brief search in ledger + */ class Acc_Ledger_Search { diff --git a/include/class/acc_operation.class.php b/include/class/acc_operation.class.php index 07f603eff..9d5701ed1 100644 --- a/include/class/acc_operation.class.php +++ b/include/class/acc_operation.class.php @@ -25,6 +25,7 @@ */ /*! + * @class Acc_Operation * \brief this file match the tables jrn & jrnx the purpose is to * remove or save accountant writing to these table. * @@ -819,6 +820,11 @@ class Acc_Operation } ///////////////////////////////////////////////////////////////////////////// + +/** + * @class Acc_Detail + * @brief Contains the detail of an operation Acc_Operation + */ class Acc_Detail extends Acc_Operation { function __construct($p_cn,$p_jrid=0) @@ -864,6 +870,7 @@ class Acc_Detail extends Acc_Operation } ///////////////////////////////////////////////////////////////////////////// /** + * @class Acc_Misc *@brief this class manage data from the JRNX and JRN * table *@note Data member are the column of the table @@ -914,6 +921,7 @@ class Acc_Misc extends Acc_Detail } ///////////////////////////////////////////////////////////////////////////// /** + * @class Acc_Sold *@brief this class manage data from the QUANT_SOLD * table *@note Data member are the column of the table @@ -967,6 +975,7 @@ class Acc_Sold extends Acc_Detail } ///////////////////////////////////////////////////////////////////////////// /** + * @class Acc_Purchase *@brief this class manage data from the QUANT_PURCHASE * table *@note Data member are the column of the table @@ -1023,6 +1032,7 @@ class Acc_Purchase extends Acc_Detail } ///////////////////////////////////////////////////////////////////////////// /** + * @class Acc_Fin *@brief this class manage data from the QUANT_FIN * table *@note Data member are the column of the table diff --git a/include/class/acc_report.class.php b/include/class/acc_report.class.php index 750dd3c70..64fba8cd7 100644 --- a/include/class/acc_report.class.php +++ b/include/class/acc_report.class.php @@ -25,6 +25,7 @@ require_once NOALYSS_INCLUDE.'/database/form_detail_sql.class.php'; require_once NOALYSS_INCLUDE.'/database/form_definition_sql.class.php'; /*! + * \class Acc_Report * \brief Class rapport Create, view, modify and parse report */ @@ -34,7 +35,9 @@ class Acc_Report private $form_definition; /*!< form_definition_sql var $nb; - /*!\brief Constructor */ + /*! + \brief Constructor + */ function __construct($p_cn,$p_id=-1) { $this->form_definition=new Form_Definition_SQL($p_cn,$p_id); @@ -55,7 +58,8 @@ class Acc_Report { return $this->form_definition->getp("fr_label"); } - /*!\brief return all the row and parse formula + /*! + * \brief return all the row and parse formula * from a report * \param $p_start start periode * \param $p_end end periode @@ -97,7 +101,8 @@ class Acc_Report return $col; } - /*!\brief save into form and form_def + /*! + * \brief save into form and form_def */ function save() { diff --git a/include/class/acc_report_mtable.class.php b/include/class/acc_report_mtable.class.php index 7ff792cea..ab9a8f16c 100644 --- a/include/class/acc_report_mtable.class.php +++ b/include/class/acc_report_mtable.class.php @@ -24,6 +24,10 @@ require_once NOALYSS_INCLUDE.'/database/form_detail_sql.class.php'; * @file * @brief manage simple report */ +/** + * @class Acc_Report_MTable + * @brief manage simple report + */ class Acc_Report_MTable extends Manage_Table_SQL { @@ -34,6 +38,14 @@ class Acc_Report_MTable extends Manage_Table_SQL parent::__construct($p_table); } + /** + * + * @brief build an object Acc_Report_MTable + * @param int $p_id Form_Detail_SQL.id + * @param int $p_form_def_id Parent Form + * @returns Acc_Report_MTable + * @throws Exception + */ static function build($p_id, $p_form_def_id) { $cn=Dossier::connect(); diff --git a/include/class/action_document_type_mtable.class.php b/include/class/action_document_type_mtable.class.php index ceab05006..0a4b68d65 100644 --- a/include/class/action_document_type_mtable.class.php +++ b/include/class/action_document_type_mtable.class.php @@ -26,7 +26,7 @@ require_once NOALYSS_INCLUDE."/database/document_type_sql.class.php"; /** - * @class + * @class Action_Document_Type_MTable * @brief display , modify and add document_type for follow up * @see include/ajax/ajax_cfgaction.php * @see include/cfg_action.inc.php diff --git a/include/class/anc_acc_link.class.php b/include/class/anc_acc_link.class.php index 4a5b187ff..48321a0de 100644 --- a/include/class/anc_acc_link.class.php +++ b/include/class/anc_acc_link.class.php @@ -19,10 +19,14 @@ // Copyright Author Dany De Bontridder danydb@aevalys.eu -/*!\file +/*! +* \file + * \brief link between accountancy and analytic, like table but as a listing + */ +/*! + * \class Anc_Acc_Link * \brief link between accountancy and analytic, like table but as a listing */ - class Anc_Acc_Link extends Anc_Print { function __contruct($p_cn) diff --git a/include/class/anc_acc_list.class.php b/include/class/anc_acc_list.class.php index a93a76df7..2b62f8657 100644 --- a/include/class/anc_acc_list.class.php +++ b/include/class/anc_acc_list.class.php @@ -23,6 +23,11 @@ * \brief */ +/*! + * \class Anc_Acc_List + * \brief Manage the class for reporting about Analytic Accountancy and Accountancy : card - analytic account, + * accounting - analytic account, + */ class Anc_Acc_List extends Anc_Acc_Link { @@ -53,7 +58,7 @@ class Anc_Acc_List extends Anc_Acc_Link return $r; } /** - * load the data + * \brief load the data * does not return anything but give a value to this->aheader and this->arow */ function load_anc_account() @@ -103,7 +108,7 @@ END) <> 0::numeric order by po_id,j_poste } /** - * load the data + * \brief load the data * does not return anything but give a value to this->aheader and this->arow */ function load_anc_card() @@ -153,7 +158,7 @@ END) <> 0::numeric order by po_name,name",array($this->pa_id)); } /** - * load the data + * \brief load the data * does not return anything but give a value to this->aheader and this->arow */ function load_poste() @@ -206,7 +211,7 @@ END) <> 0::numeric order by po_id,po_name } /** - * load the data + * \brief load the data * does not return anything but give a value to this->aheader and this->arow */ function load_card() diff --git a/include/class/anc_account.class.php b/include/class/anc_account.class.php index 9975b6170..b6e73fd70 100644 --- a/include/class/anc_account.class.php +++ b/include/class/anc_account.class.php @@ -23,6 +23,10 @@ * @file * @brief Analytic account */ +/** + * @class Anc_Account + * @brief Analytic account ; get the balance + */ class Anc_Account { diff --git a/include/class/anc_grandlivre.class.php b/include/class/anc_grandlivre.class.php index 01cde7809..689fd331b 100644 --- a/include/class/anc_grandlivre.class.php +++ b/include/class/anc_grandlivre.class.php @@ -19,10 +19,14 @@ // Copyright Author Dany De Bontridder danydb@aevalys.eu -/*!\file - * \brief show the Grand Livre for analytic +/*! + *\file + * \brief report the Grand Livre for analytic */ +/*!\class Anc_GrandLivre + * \brief report he Grand Livre for analytic + */ class Anc_GrandLivre extends Anc_Print { diff --git a/include/class/anc_key.class.php b/include/class/anc_key.class.php index a040e5090..ecbd631b3 100644 --- a/include/class/anc_key.class.php +++ b/include/class/anc_key.class.php @@ -25,6 +25,14 @@ * @brief Class to manage distribution keys for Analytic accountancy * */ + + +/** + * @class Anc_Key + * @brief Class to manage distribution keys for Analytic accountancy + * + */ + require_once NOALYSS_INCLUDE.'/database/anc_key_sql.class.php'; class Anc_Key diff --git a/include/class/anc_print.class.php b/include/class/anc_print.class.php index e16271edd..72165b89c 100644 --- a/include/class/anc_print.class.php +++ b/include/class/anc_print.class.php @@ -23,7 +23,9 @@ * \brief this class is the mother class for the CA printing */ -/*! \brief this class is the mother class for the CA printing +/*! + * \class Anc_Print + * \brief this class is the mother class for the CA printing * * */ diff --git a/include/class/anc_table.class.php b/include/class/anc_table.class.php index c7f000715..65b46c042 100644 --- a/include/class/anc_table.class.php +++ b/include/class/anc_table.class.php @@ -19,10 +19,14 @@ // Copyright Author Dany De Bontridder danydb@aevalys.eu -/*!\file - * \brief object to show a table: link between accountancy and analytic +/*! + * \file + * \brief printing analytic and accountancy as a table + */ +/*! + * \class Anc_Table + * \brief printing analytic and accountancy as a table */ - class Anc_Table extends Anc_Acc_Link { function __construct($p_cn) diff --git a/include/class/balance_age.class.php b/include/class/balance_age.class.php index f56753259..8034edc29 100644 --- a/include/class/balance_age.class.php +++ b/include/class/balance_age.class.php @@ -18,12 +18,18 @@ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ -/* * * +/** * @file * @brief compute the ageing balance, currently this code is not used * */ +/** + * @class Balance_Age + * @brief compute the ageing balance, currently this code is not used + * + */ + class Balance_Age { diff --git a/include/class/calendar.class.php b/include/class/calendar.class.php index 58aa9e149..a9ada1868 100644 --- a/include/class/calendar.class.php +++ b/include/class/calendar.class.php @@ -19,7 +19,13 @@ // Copyright Author Dany De Bontridder danydb@aevalys.eu -/*!\file +/*! + * \file + * \brief Display the calendar + */ + +/*! + * \class Calendar * \brief Display the calendar */ class Calendar @@ -42,7 +48,8 @@ class Calendar $this->day=29; } - /*!\brief fill the array given as parameter with the data from action_gestion + /*! + * \brief fill the array given as parameter with the data from action_gestion *\param $p_array array of the date of the month * \param $p_style is either short or long, short: for a small title, long for a complete one */ @@ -114,7 +121,8 @@ class Calendar } } } - /*!\brief fill the array given as parameter with the data from todo + /*! + * \brief fill the array given as parameter with the data from todo *\param $p_array array of the date of the month * \param $p_style is either short or long, short: for a small title, long for a complete one */ @@ -152,7 +160,8 @@ class Calendar } } } - /*!\brief display a calendar after a call to Calendar::fill + /*! + * \brief display a calendar after a call to Calendar::fill *\param $p_type long or short * *\return HTML String diff --git a/include/class/card_attribut_mtable.class.php b/include/class/card_attribut_mtable.class.php index a2b954639..8f052a85f 100644 --- a/include/class/card_attribut_mtable.class.php +++ b/include/class/card_attribut_mtable.class.php @@ -24,7 +24,11 @@ * @brief manage the table attr_def * @see card_attr.inc.php */ - +/** + * @class Card_Attribut_MTable + * @brief manage the table attr_def + * @see card_attr.inc.php + */ class Card_Attribut_MTable extends Manage_Table_SQL { diff --git a/include/class/card_multiple.class.php b/include/class/card_multiple.class.php index 06c665b77..b7a2f3c82 100644 --- a/include/class/card_multiple.class.php +++ b/include/class/card_multiple.class.php @@ -23,6 +23,11 @@ * @file * @brief in follow-up , add multiple cards to an event, an action */ + +/** + * @class Card_Multiple + * @brief in follow-up , add multiple cards to an event, an action + */ class Card_Multiple { private $sql ; //!< SQL with the right column name diff --git a/include/class/contact_option_ref_mtable.class.php b/include/class/contact_option_ref_mtable.class.php index ed84e6945..07cc21408 100644 --- a/include/class/contact_option_ref_mtable.class.php +++ b/include/class/contact_option_ref_mtable.class.php @@ -22,8 +22,12 @@ /** * @file - * @brief - * @todo to be implemented + * @brief Manage the Options for the Card_Multiple in the Follow Up + */ + +/** + * @class Contact_Option_Ref_MTable + * @brief Manage the Options for the Card_Multiple in the Follow Up */ require_once NOALYSS_INCLUDE."/database/contact_option_ref_sql.class.php"; diff --git a/include/class/data_currency_operation.class.php b/include/class/data_currency_operation.class.php index c46d972fa..48aba96b0 100644 --- a/include/class/data_currency_operation.class.php +++ b/include/class/data_currency_operation.class.php @@ -25,7 +25,7 @@ */ /** - * @class + * @class Data_Currency_Operation * @brief build the SQL and fetch data of data currency operation from database , */ class Data_Currency_Operation diff --git a/include/class/database.class.php b/include/class/database.class.php index 53a8261ce..33918bb90 100644 --- a/include/class/database.class.php +++ b/include/class/database.class.php @@ -25,7 +25,10 @@ * \brief contains the class for connecting to Noalyss */ - +/** + * \class Database + * \brief contains the class for connecting to Noalyss + */ class Database extends DatabaseCore { /**\brief constructor diff --git a/include/class/document_option.class.php b/include/class/document_option.class.php index d515a51ba..9716de352 100644 --- a/include/class/document_option.class.php +++ b/include/class/document_option.class.php @@ -21,12 +21,14 @@ /** * @file - * @brief + * @brief in follow-up , you have action which can be set with different options depending of the type of documents like + * invoicing, meeting, ... */ /** - * @class - * @brief + * @class Document_Option + * @brief in follow-up , you have action which can be set with different options depending of the type of documents like + * invoicing, meeting, ... */ class Document_Option { diff --git a/include/class/document_type.class.php b/include/class/document_type.class.php index 946202604..170e81e24 100644 --- a/include/class/document_type.class.php +++ b/include/class/document_type.class.php @@ -19,17 +19,19 @@ */ // Copyright Author Dany De Bontridder danydb@aevalys.eu -/** \file +/** + * \file * \brief class for the table document_type */ -/** \ +/** + * @class Document_Type *@brief class for the table document_type , a document_type is a kind of action in the follow up * * < dt_id pk document_type * < dt_value value */ -class Document_type +class Document_Type { /** document_type * \brief constructor diff --git a/include/class/exercice.class.php b/include/class/exercice.class.php index 03917a7a0..eb9bb76af 100644 --- a/include/class/exercice.class.php +++ b/include/class/exercice.class.php @@ -20,7 +20,12 @@ // Copyright Author Dany De Bontridder danydb@aevalys.eu /*!\file - * \brief about the accountant exercice + * \brief about the accountancy period (usually 1 year starting in January until december) = exercice + */ + +/*! + * \class Exercice + * \brief about the accountancy period (usually 1 year starting in January until december) = exercice */ class Exercice { diff --git a/include/class/filter_data_currency_accounting.class.php b/include/class/filter_data_currency_accounting.class.php index b0be484da..23769da60 100644 --- a/include/class/filter_data_currency_accounting.class.php +++ b/include/class/filter_data_currency_accounting.class.php @@ -27,7 +27,7 @@ */ /** - * @class + * @class Filter_Data_Currency_Accounting * @brief filter data in currency from datase , inherit from Data_Currency_Operation, filter on * a range of accounting or only one */ diff --git a/include/class/filter_data_currency_card.class.php b/include/class/filter_data_currency_card.class.php index 1aa4e9c34..739b6130c 100644 --- a/include/class/filter_data_currency_card.class.php +++ b/include/class/filter_data_currency_card.class.php @@ -27,7 +27,7 @@ */ /** - * @class + * @class Filter_Data_Currency_Card * @brief filter data in currency froqm datase , inherit from Data_Currency_Operation, filter on * a specific card */ diff --git a/include/class/filter_data_currency_card_category.class.php b/include/class/filter_data_currency_card_category.class.php index eb4ae0392..5b248b596 100644 --- a/include/class/filter_data_currency_card_category.class.php +++ b/include/class/filter_data_currency_card_category.class.php @@ -26,7 +26,7 @@ */ /** - * \class + * \class Filter_Data_Currency_Card_Category * \brief filter data in currency from datase , inherit from Data_Currency_Operation, filter on * card category */ diff --git a/include/class/follow_up_other_concerned.class.php b/include/class/follow_up_other_concerned.class.php index e2c457f5e..d1ba3aea9 100644 --- a/include/class/follow_up_other_concerned.class.php +++ b/include/class/follow_up_other_concerned.class.php @@ -27,7 +27,7 @@ */ /** - * @class + * @class Follow_Up_Other_Concerned * @brief Others concerned card in an action * @see Follow_Up */ diff --git a/include/class/forecast_category_mtable.class.php b/include/class/forecast_category_mtable.class.php index 8c2444197..5f92eca07 100644 --- a/include/class/forecast_category_mtable.class.php +++ b/include/class/forecast_category_mtable.class.php @@ -25,7 +25,11 @@ * \brief display, add, delete and modify forecast category * */ - +/** + * \class Forecast_Category_MTable + * \brief display, add, delete and modify forecast category + * + */ require_once NOALYSS_INCLUDE."/database/forecast_category_sql.class.php"; class Forecast_Category_MTable extends Manage_Table_SQL diff --git a/include/class/forecast_item_mtable.class.php b/include/class/forecast_item_mtable.class.php index 45ae780ff..213fae2ab 100644 --- a/include/class/forecast_item_mtable.class.php +++ b/include/class/forecast_item_mtable.class.php @@ -29,7 +29,10 @@ * @file * @brief display the item for forecast */ - +/** + * @class Forecast_Item_MTable + * @brief display the item for forecast + */ require_once NOALYSS_INCLUDE . "/database/forecast_item_sql.class.php"; require_once NOALYSS_INCLUDE . "/database/forecast_sql.class.php"; diff --git a/include/class/html_input_noalyss.class.php b/include/class/html_input_noalyss.class.php index 68ddb4057..ac1ea03d5 100644 --- a/include/class/html_input_noalyss.class.php +++ b/include/class/html_input_noalyss.class.php @@ -22,14 +22,15 @@ */ /** * @file - * @brief + * @brief HtmlInput specific to Noalyss * */ // Copyright Author Dany De Bontridder danydb@noalyss.eu /** - * @class - * @brief + * @class Html_Input_Noalyss + * @brief HtmlInput specific to Noalyss + * * */ class Html_Input_Noalyss extends HtmlInput diff --git a/include/class/menu_ref.class.php b/include/class/menu_ref.class.php index 7677bf3cb..091438ad8 100644 --- a/include/class/menu_ref.class.php +++ b/include/class/menu_ref.class.php @@ -21,6 +21,10 @@ *@file *@brief Menu_Ref let you manage the available menu */ +/** + *@class Menu_Ref + *@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 { diff --git a/include/class/package_core.class.php b/include/class/package_core.class.php index d6a37d215..dbca0f89d 100644 --- a/include/class/package_core.class.php +++ b/include/class/package_core.class.php @@ -23,6 +23,11 @@ * @file * @brief Class Package Core to install the core , if possible */ + +/** + * @class Package_Core + * @brief Class Package Core to install the core , if possible + */ class Package_Core extends Package_Noalyss { diff --git a/include/class/package_noalyss.class.php b/include/class/package_noalyss.class.php index 6e1828875..025c5f4a9 100644 --- a/include/class/package_noalyss.class.php +++ b/include/class/package_noalyss.class.php @@ -23,6 +23,11 @@ * @file * @brief package noalyss is the mother class of the class to install and download package */ +/** + * @class Package_Noalyss + * @brief package noalyss is the mother class of the class to install and download package + */ + abstract class Package_Noalyss { diff --git a/include/class/package_template.class.php b/include/class/package_template.class.php index 31c4d67d0..85c7747f2 100644 --- a/include/class/package_template.class.php +++ b/include/class/package_template.class.php @@ -1,3 +1,4 @@ + increment_mail($repo,$dossier,$date); } /** - * Check if email can be sent from a folder + * @brief Check if email can be sent from a folder * @return boolean */ function can_send() { @@ -81,7 +88,7 @@ class Sendmail extends Sendmail_Core return true; } /** - * return max email the folder can send + *@brief return max email the folder can send * @param $p_repo Database * @param $p_dossier_id int */ @@ -92,7 +99,7 @@ class Sendmail extends Sendmail_Core return $max_email; } /** - * Return the amount of send emails for the date (YYYYMMDD) + * @brief Return the amount of send emails for the date (YYYYMMDD) * @param Database $p_repo * @param $p_dossier_id int * @param $p_date string YYYYMMDD @@ -107,7 +114,7 @@ class Sendmail extends Sendmail_Core } /** - * Add $p_amount_email to email sent + * @brief Add $p_amount_email to email sent * @param $p_repo Database * @param $p_dossier int id of the folder (dossier.dos_id) * @param $p_date string (YYYYMMDD) diff --git a/include/class/stock.class.php b/include/class/stock.class.php index f4f35d7c3..2d8ac6530 100644 --- a/include/class/stock.class.php +++ b/include/class/stock.class.php @@ -22,10 +22,15 @@ /** * @file - * @brief + * @brief manage the stocks * * */ + +/** + * @class Stock + * @brief manage the stocks + */ require_once NOALYSS_INCLUDE.'/database/stock_sql.class.php'; class Stock extends Stock_Sql diff --git a/include/class/stock_goods.class.php b/include/class/stock_goods.class.php index 899eecf79..1e2d8da7d 100644 --- a/include/class/stock_goods.class.php +++ b/include/class/stock_goods.class.php @@ -25,6 +25,12 @@ * @brief Manage the goods * */ + +/** + * @class Stock_Goods + * @brief Manage the goods + * + */ require_once NOALYSS_INCLUDE.'/database/stock_goods_sql.class.php'; class Stock_Goods extends Stock_Goods_Sql diff --git a/include/class/tag.class.php b/include/class/tag.class.php index 5b2097e34..760a6e031 100644 --- a/include/class/tag.class.php +++ b/include/class/tag.class.php @@ -19,6 +19,15 @@ // Copyright Author Dany De Bontridder danydb@aevalys.eu require_once NOALYSS_INCLUDE.'/database/tag_sql.class.php'; +/** + * @file + * @brief Tag operations or actions to linked them together + */ + +/** + * @class Tag + * @brief Tag operations or actions to linked them together + */ class Tag { private $data; //array=$array; return $this; } - // $empty replace the empty value + /*! + * \brief $empty replace the empty value + * + */ public function set_empty($empty) { $this->empty=$empty; @@ -64,7 +71,7 @@ class HttpInput } /** - * Check the type of the value + * \brief 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 @@ -132,7 +139,7 @@ class HttpInput } /** - * Retrieve from $this->array the variable + * @brief Retrieve from $this->array the variable * @param $p_name name of the variable * @param $p_type type of the variable (number,string,date('dd.mm.yyyy'),array) * @param $p_default default value is variable @@ -172,7 +179,7 @@ class HttpInput } /** - * Retrieve from $_GET + * @brief Retrieve from $_GET * @param $p_name name of the variable * @param $p_type type of the variable , opt. default string * @param $p_default default value is variable is not set @@ -197,7 +204,7 @@ class HttpInput } /** - * Retrieve from $_POST + * @brief Retrieve from $_POST * @param string $p_name name of the variable * @param $p_type type of the variable , opt. default string * @param $p_default default value is variable is not set @@ -221,7 +228,7 @@ class HttpInput } } /** - * Retrieve from $_REQUEST + * @brief Retrieve from $_REQUEST * @param $p_name name of the variable * @param $p_type type of the variable , opt. default string * @param $p_default default value is variable is not set @@ -245,7 +252,7 @@ class HttpInput } } /** - * Retrieve from $p_array + * @brief Retrieve from $p_array * @param $p_array source * @param $p_name name of the variable * @param $p_type type of the variable , opt. default string @@ -271,7 +278,7 @@ class HttpInput } /** - * Extract variable name from an exception message. If an exception is thrown + * @brief Extract variable name from an exception message. If an exception is thrown * then thanks this function it is possible to know what variable triggers * the exception * @param type $p_string diff --git a/include/lib/ianccard.class.php b/include/lib/ianccard.class.php index 02bcc5aa0..a04d9b731 100644 --- a/include/lib/ianccard.class.php +++ b/include/lib/ianccard.class.php @@ -25,7 +25,8 @@ */ /*! - * \brief +* \class IAncCard + * \brief HtmlInput for card of analytic accountancy */ require_once NOALYSS_INCLUDE.'/lib/function_javascript.php'; diff --git a/include/lib/ibutton.class.php b/include/lib/ibutton.class.php index 304b9ddfa..f2c48b69e 100644 --- a/include/lib/ibutton.class.php +++ b/include/lib/ibutton.class.php @@ -22,6 +22,11 @@ /*!\file * \brief Html Input */ + +/*! + * \class IButton + * \brief Html Input + */ class IButton extends HtmlInput { var $label; diff --git a/include/lib/icheckbox.class.php b/include/lib/icheckbox.class.php index 81cb90b9f..d89ebd547 100644 --- a/include/lib/icheckbox.class.php +++ b/include/lib/icheckbox.class.php @@ -22,6 +22,11 @@ /*!\file * \brief Html Input */ + +/*! + * \class ICheckBox + * \brief Html Input + */ class ICheckBox extends HtmlInput { var $range; diff --git a/include/lib/iconcerned.class.php b/include/lib/iconcerned.class.php index 7fc86b7e8..be3324d10 100644 --- a/include/lib/iconcerned.class.php +++ b/include/lib/iconcerned.class.php @@ -20,13 +20,20 @@ // Copyright Author Dany De Bontridder danydb@aevalys.eu -/* !\file +/*! + * \file + * \brief Html Input + * - name is the name and id of the input + * - extra amount of the operation to reconcile + * - extra2 ledger paid + */ +/*! + * \class IConcerned * \brief Html Input * - name is the name and id of the input * - extra amount of the operation to reconcile * - extra2 ledger paid */ - class IConcerned extends HtmlInput { diff --git a/include/lib/ifile.class.php b/include/lib/ifile.class.php index b2d1f8d05..7b64b8091 100644 --- a/include/lib/ifile.class.php +++ b/include/lib/ifile.class.php @@ -22,6 +22,11 @@ /*!\file * \brief Html Input */ + +/*! + * \class IFile + * \brief Html Input + */ class IFile extends HtmlInput { // if true , the size is tested and a box is displaid diff --git a/include/lib/ihidden.class.php b/include/lib/ihidden.class.php index af943d095..ae2f07271 100644 --- a/include/lib/ihidden.class.php +++ b/include/lib/ihidden.class.php @@ -22,6 +22,11 @@ /*!\file * \brief Html Input */ + +/*!\class IHidden + * \brief Html Input + */ + class IHidden extends HtmlInput { /*!\brief show the html input of the widget*/ diff --git a/include/lib/impress.class.php b/include/lib/impress.class.php index dececb03b..1520cc88c 100644 --- a/include/lib/impress.class.php +++ b/include/lib/impress.class.php @@ -25,7 +25,7 @@ */ /** - * @class + * @class Impress * @brief contains function for the parsing and computing formulae . Test are in scenario/test_parse_formula.php */ class Impress diff --git a/include/lib/inplace_switch.class.php b/include/lib/inplace_switch.class.php index 914ca0fe2..f5d5e4285 100644 --- a/include/lib/inplace_switch.class.php +++ b/include/lib/inplace_switch.class.php @@ -24,6 +24,12 @@ * @brief A switch let you switch between 2 values : 0 and 1, it is used to * replace the check */ +/** + * @class Inplace_Switch + * @brief A switch let you switch between 2 values : 0 and 1, it is used to + * replace the check + */ + class Inplace_Switch { diff --git a/include/lib/input_checkbox.class.php b/include/lib/input_checkbox.class.php index 5206a48a0..aa1cc8f5f 100644 --- a/include/lib/input_checkbox.class.php +++ b/include/lib/input_checkbox.class.php @@ -25,7 +25,12 @@ /** * @file * @brief modern checkbox, using a javascript to change the icon when clicked and a hidden field, there is always a - * value , either 1 or 0 + * value , either 1 or 0 EXPERIMENTAL + */ +/** + * @class + * @brief modern checkbox, using a javascript to change the icon when clicked and a hidden field, there is always a + * value , either 1 or 0 , EXPERIMENTAL */ class InputCheckBox extends HtmlInput diff --git a/include/lib/input_switch.class.php b/include/lib/input_switch.class.php index bcbf0c451..19d0990be 100644 --- a/include/lib/input_switch.class.php +++ b/include/lib/input_switch.class.php @@ -26,6 +26,10 @@ * @file * @brief show a switch, when you click on it an hidden field is changed, the value is 1 or 0 */ +/** + * @class InputSwitch + * @brief show a switch, when you click on it an hidden field is changed, the value is 1 or 0 + */ class InputSwitch extends HtmlInput { diff --git a/include/lib/ipopup.class.php b/include/lib/ipopup.class.php index ee5c8d4d4..c86ebe877 100644 --- a/include/lib/ipopup.class.php +++ b/include/lib/ipopup.class.php @@ -23,7 +23,15 @@ * \brief create a popup in html above the current layer * the html inside the popup cannot contain any floating elt as div.. * + * */ +/*! + * \class IPopup + * \brief create a popup in html above the current layer + * the html inside the popup cannot contain any floating elt as div.. + * + */ + require_once NOALYSS_INCLUDE.'/lib/function_javascript.php'; class IPopup extends HtmlInput diff --git a/include/lib/iradio.class.php b/include/lib/iradio.class.php index 4966aca1c..160cdec3a 100644 --- a/include/lib/iradio.class.php +++ b/include/lib/iradio.class.php @@ -23,7 +23,9 @@ /**\file * \brief Html Input */ - +/*!\class IRadio + * \brief Html Input + */ class IRadio extends HtmlInput { /**\brief show the html input of the widget */ diff --git a/include/lib/irelated_action.class.php b/include/lib/irelated_action.class.php index ef3cb431b..09e6e51ad 100644 --- a/include/lib/irelated_action.class.php +++ b/include/lib/irelated_action.class.php @@ -23,6 +23,12 @@ * \brief Html Input * - name is the name and id of the input */ + +/*! + * \class IRelated_Action + * \brief Html Input + * - name is the name and id of the input + */ class IRelated_Action extends HtmlInput { diff --git a/include/lib/iselect.class.php b/include/lib/iselect.class.php index 9e8533a74..b1aa17dc5 100644 --- a/include/lib/iselect.class.php +++ b/include/lib/iselect.class.php @@ -19,13 +19,23 @@ // Copyright Author Dany De Bontridder danydb@aevalys.eu -/*!\file +/*! + * \file * \brief Html Input , create a tag * if readonly == true then display the label corresponding to the selected value * You can use also $this->rowsize to specify the number of lines to display * * @see Database::make_array */ + +/*! + * \class ISelect + * \brief Html Input , create a tag + * if readonly == true then display the label corresponding to the selected value + * You can use also $this->rowsize to specify the number of lines to display + * + * @see Database::make_array + */ class ISelect extends HtmlInput { /** diff --git a/include/lib/ispan.class.php b/include/lib/ispan.class.php index 990a5c35a..447ffc136 100644 --- a/include/lib/ispan.class.php +++ b/include/lib/ispan.class.php @@ -19,7 +19,13 @@ // Copyright Author Dany De Bontridder danydb@aevalys.eu -/*!\file +/*! + * \file + * \brief Html Input + */ + +/*! + * \class ISpan * \brief Html Input */ class ISpan extends HtmlInput diff --git a/include/lib/itext.class.php b/include/lib/itext.class.php index 152b3dcee..4a0b1251d 100644 --- a/include/lib/itext.class.php +++ b/include/lib/itext.class.php @@ -18,8 +18,12 @@ */ // Copyright Author Dany De Bontridder danydb@aevalys.eu - -/*!\file +/*! + * \file + * \brief Html Input + */ +/*! + * \class IText * \brief Html Input */ class IText extends HtmlInput diff --git a/include/lib/noalyss_sql.class.php b/include/lib/noalyss_sql.class.php index 578730a71..b247b3f3c 100644 --- a/include/lib/noalyss_sql.class.php +++ b/include/lib/noalyss_sql.class.php @@ -27,7 +27,7 @@ */ /** - * @class + * @class Noalyss_SQL * @brief this class is deprecated and inherits from Table_Data_SQL. It remains only for compatibility * purpose * @see Table_Data_SQL diff --git a/include/lib/pdf_core.class.php b/include/lib/pdf_core.class.php index 4664cf49c..750899953 100644 --- a/include/lib/pdf_core.class.php +++ b/include/lib/pdf_core.class.php @@ -19,11 +19,16 @@ // Copyright Author Dany De Bontridder danydb@aevalys.eu -/*!\file +/*! + * \file * \brief API for creating PDF, unicode, based on tfpdf *@see TFPDF */ - +/*! + * \class Cellule + * \brief A Cellule is a cell to print + *@see TFPDF + */ require_once NOALYSS_INCLUDE.'/tfpdf/tfpdf.php'; class Cellule { var $width; @@ -49,6 +54,11 @@ class Cellule { return $this; } } +/*! + * \class PDF_Core + * \brief API for creating PDF, unicode, based on tfpdf + *@see TFPDF + */ class PDF_Core extends TFPDF { diff --git a/include/lib/sendmail_core.class.php b/include/lib/sendmail_core.class.php index 90fd4c5dd..f07648bc8 100644 --- a/include/lib/sendmail_core.class.php +++ b/include/lib/sendmail_core.class.php @@ -16,13 +16,19 @@ * along with NOALYSS; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ -// Copyright Author Dany De Bontridder danydb@aevalys.eu +// Copyright Author Dany De Bontridder danydb@noalyss.eu /** *@file *@brief API for sending email */ + +/** + *@class Sendmail_Core + *@brief API for sending email + */ + /** * Description of Sendmail * @@ -72,7 +78,7 @@ class Sendmail_Core } /** - * body of the message (utf8) + * @brief body of the message (utf8) * @param type $p_message */ function set_message($p_message) @@ -82,7 +88,7 @@ class Sendmail_Core } /** - * Add file to the message + *@brief Add file to the message * @param FileToSend $file file to add to the message */ function add_file(FileToSend $file) @@ -91,7 +97,7 @@ class Sendmail_Core } /** - * verify that the message is ready to go + * @brief verify that the message is ready to go * @throws Exception */ function verify() @@ -109,7 +115,7 @@ class Sendmail_Core /** * - * Function to override if supplemental header are needed + * @brief Function to override if supplemental header are needed * @return string */ function add_supplemental_header() @@ -117,7 +123,7 @@ class Sendmail_Core return ''; } /** - * create the message before sending + *@brief create the message before sending */ function compose() { @@ -136,9 +142,6 @@ class Sendmail_Core $this->header .= "MIME-Version: 1.0" . $eol; $this->header .= $this->add_supplemental_header(); $this->header .= "Content-Type: multipart/mixed; boundary=\"" . $separator . "\"" ; - //$headers .= "Content-Transfer-Encoding: 7bit" . $eol; - //$headers .= "This is a MIME encoded message." . $eol ; - //$headers .= $eol . $eol; // message $this->content .= "--" . $separator . $eol; @@ -175,7 +178,7 @@ class Sendmail_Core } /** - * Send email + *@brief Send email * @throws Exception */ function send() diff --git a/include/lib/table_data_sql.class.php b/include/lib/table_data_sql.class.php index 8097e2779..51af6ad27 100644 --- a/include/lib/table_data_sql.class.php +++ b/include/lib/table_data_sql.class.php @@ -19,10 +19,13 @@ */ // Copyright Author Dany De Bontridder danydb@aevalys.eu - /** * @file - * @brief this wrapper is used to created easily a wrapper to a table + * @brief interface : for creating ORM Object + */ +/** + * @class Table_Data_SQL + * @brief Interface : this wrapper is used to created easily a wrapper to a table (ORM) * You must create a class extending this one, in the constructor * these variables have to be defined * diff --git a/include/lib/zip_extended.class.php b/include/lib/zip_extended.class.php index 4d2b41818..f5d4d910c 100644 --- a/include/lib/zip_extended.class.php +++ b/include/lib/zip_extended.class.php @@ -19,7 +19,12 @@ // Copyright Author Dany De Bontridder danydb@aevalys.eu -/*!\file +/*! + * \file + * \brief extends the Zip object + */ +/*! + * \class Zip_Extended * \brief extends the Zip object */