From cce910ba5f80bb119b147e99596730057cbdaee7 Mon Sep 17 00:00:00 2001 From: sparkyx Date: Wed, 12 Dec 2007 22:56:22 +0000 Subject: [PATCH] Update doxygen documentation --- doc/developper/Doxyfile | 2 +- doc/header-file.txt | 7 ++----- html/admin/sql/mod1/schema.sql | 5 ----- html/ajax_import.php | 2 +- html/budget.php | 2 +- include/class_acc_ledger.php | 5 +++-- include/class_acc_operation.php | 4 +++- include/class_acc_reconciliation.php | 12 ++++++------ include/class_acexception.php | 2 +- include/class_anc_group.php | 4 +++- include/class_balance_ca.php | 3 ++- include/class_balance_ca_bc.php | 4 +++- include/class_balance_ca_bs.php | 9 +++++---- include/class_bud_card.php | 6 ++---- include/class_bud_detail.php | 12 +++++++++--- include/class_bud_detail_period.php | 2 +- include/class_bud_hypo.php | 8 +++----- include/constant.php | 2 +- include/hypo.inc.php | 3 +-- 19 files changed, 48 insertions(+), 46 deletions(-) diff --git a/doc/developper/Doxyfile b/doc/developper/Doxyfile index e436bbdea..daa477837 100644 --- a/doc/developper/Doxyfile +++ b/doc/developper/Doxyfile @@ -124,7 +124,7 @@ FILE_PATTERNS = *.c \ *.js \ *.inc.php RECURSIVE = YES -EXCLUDE = +EXCLUDE = addon EXCLUDE_SYMLINKS = NO EXCLUDE_PATTERNS = a?.php b?.php ?.php test*.php EXAMPLE_PATH = diff --git a/doc/header-file.txt b/doc/header-file.txt index 73300ae7f..80671351e 100644 --- a/doc/header-file.txt +++ b/doc/header-file.txt @@ -20,9 +20,6 @@ // Copyright Author Dany De Bontridder ddebontridder@yahoo.fr -/* !\file - */ - -/*! \brief - * +/*! \file + * \brief Manage the hypothese for the budget module */ diff --git a/html/admin/sql/mod1/schema.sql b/html/admin/sql/mod1/schema.sql index 1065e529e..58845f5dc 100644 --- a/html/admin/sql/mod1/schema.sql +++ b/html/admin/sql/mod1/schema.sql @@ -861,7 +861,6 @@ CREATE SEQUENCE action_gestion_ag_id_seq -ALTER SEQUENCE action_gestion_ag_id_seq OWNED BY action_gestion.ag_id; @@ -988,7 +987,6 @@ CREATE SEQUENCE document_d_id_seq -ALTER SEQUENCE document_d_id_seq OWNED BY document.d_id; @@ -1016,7 +1014,6 @@ CREATE SEQUENCE document_modele_md_id_seq -ALTER SEQUENCE document_modele_md_id_seq OWNED BY document_modele.md_id; @@ -1052,7 +1049,6 @@ CREATE SEQUENCE document_state_s_id_seq -ALTER SEQUENCE document_state_s_id_seq OWNED BY document_state.s_id; @@ -1076,7 +1072,6 @@ CREATE SEQUENCE document_type_dt_id_seq -ALTER SEQUENCE document_type_dt_id_seq OWNED BY document_type.dt_id; diff --git a/html/ajax_import.php b/html/ajax_import.php index 6102a2f60..4cdfc3dc4 100644 --- a/html/ajax_import.php +++ b/html/ajax_import.php @@ -20,7 +20,7 @@ // Copyright Author Dany De Bontridder ddebontridder@yahoo.fr -/* !\file ajax file called by the import screen +/*!\file ajax file called by the import screen */ /* \brief update , delete or remove a record from the confirmed list diff --git a/html/budget.php b/html/budget.php index 2aeb2d33d..fcb89c188 100644 --- a/html/budget.php +++ b/html/budget.php @@ -47,7 +47,7 @@ $User->Check(); echo '
'; echo '
'; -echo "

Commercial ".dossier::name()."

"; +echo "

Budget : ".dossier::name()."

"; echo '

'; echo '
'; diff --git a/include/class_acc_ledger.php b/include/class_acc_ledger.php index 0f662f844..0ad78de02 100644 --- a/include/class_acc_ledger.php +++ b/include/class_acc_ledger.php @@ -30,10 +30,11 @@ require_once ('class_pre_op_advanced.php'); require_once ('jrn.php'); require_once ('class_acexception.php'); require_once ('class_acc_reconciliation.php'); -/*!\file class acc_ledger for manipulating the ledger +/*!\file + * \brief Class for jrn, class acc_ledger for manipulating the ledger */ -/*!\brief Class for jrn +/*!\brief Class for jrn, class acc_ledger for manipulating the ledger * */ class Acc_Ledger { diff --git a/include/class_acc_operation.php b/include/class_acc_operation.php index eb5601aa6..44d84c460 100644 --- a/include/class_acc_operation.php +++ b/include/class_acc_operation.php @@ -20,7 +20,9 @@ // Copyright Author Dany De Bontridder ddebontridder@yahoo.fr -/* !\file +/*!\file + * \brief this file match the tables jrn & jrnx the purpose is to + * remove or save accountant writing to these table. */ require_once ('class_user.php'); /*! \brief this file match the tables jrn & jrnx the purpose is to diff --git a/include/class_acc_reconciliation.php b/include/class_acc_reconciliation.php index 52ec75c55..f3f8796f9 100644 --- a/include/class_acc_reconciliation.php +++ b/include/class_acc_reconciliation.php @@ -20,19 +20,19 @@ // Copyright Author Dany De Bontridder ddebontridder@yahoo.fr - /* !\file */ - /*!\brief class acc_reconciliation, this class is new and the code - must use it (remove the function insertRapt) - +/*!\file + * \brief class acc_reconciliation, this class is new and the code + * must use it (remove the function insertRapt) + * */ - /*!\todo replace all the use of the reconciliation by this class +/*!\todo replace all the use of the reconciliation by this class */ require_once ('postgres.php'); require_once ('class_dossier.php'); require_once ('class_widget.php'); -/* \brief new class for managing the reconciliation it must be used +/*! \brief new class for managing the reconciliation it must be used * instead of the function InsertRapt, ... * */ diff --git a/include/class_acexception.php b/include/class_acexception.php index 10833e266..9efca367f 100644 --- a/include/class_acexception.php +++ b/include/class_acexception.php @@ -20,7 +20,7 @@ // Copyright Author Dany De Bontridder ddebontridder@yahoo.fr -/* !\file +/*!\file */ /* \brief acException extends Exception diff --git a/include/class_anc_group.php b/include/class_anc_group.php index cc6d8a626..4301d7a19 100644 --- a/include/class_anc_group.php +++ b/include/class_anc_group.php @@ -20,7 +20,9 @@ // Copyright Author Dany De Bontridder ddebontridder@yahoo.fr -/* !\file +/*!\file + * \brief class for the group of the analytic account + * */ require_once ('postgres.php'); require_once ('constant.php'); diff --git a/include/class_balance_ca.php b/include/class_balance_ca.php index 0bda7c466..03702ae07 100644 --- a/include/class_balance_ca.php +++ b/include/class_balance_ca.php @@ -20,7 +20,8 @@ // Copyright Author Dany De Bontridder ddebontridder@yahoo.fr -/* !\file +/*!\file + * \brief this class is the mother class for the CA balance */ /* \brief this class is the mother class for the CA balance diff --git a/include/class_balance_ca_bc.php b/include/class_balance_ca_bc.php index b9c7df547..d61fe8ce7 100644 --- a/include/class_balance_ca_bc.php +++ b/include/class_balance_ca_bc.php @@ -20,7 +20,9 @@ // Copyright Author Dany De Bontridder ddebontridder@yahoo.fr -/* !\file +/*!\file + * \brief + * Print the crossed balance between 2 plan */ /* \brief diff --git a/include/class_balance_ca_bs.php b/include/class_balance_ca_bs.php index 47bede0fd..cbd01029d 100644 --- a/include/class_balance_ca_bs.php +++ b/include/class_balance_ca_bs.php @@ -20,17 +20,18 @@ // Copyright Author Dany De Bontridder ddebontridder@yahoo.fr -/* !\file +/*!\file + \brief manage the simple balance for CA, inherit from balance_ca */ -/* \brief manage the simple balance for CA, inherit from balance_ca - * - */ require_once ('class_print_ca.php'); require_once ('class_plananalytic.php'); require_once ('ac_common.php'); include_once("class.ezpdf.php"); require_once ('header_print.php'); +/*! \brief manage the simple balance for CA, inherit from balance_ca + * + */ class balance_ca_bs extends print_ca { diff --git a/include/class_bud_card.php b/include/class_bud_card.php index a9bc9da0a..63bfc1e9f 100644 --- a/include/class_bud_card.php +++ b/include/class_bud_card.php @@ -20,10 +20,8 @@ // Copyright Author Dany De Bontridder ddebontridder@yahoo.fr -/* !\file - */ - -/*! \brief class to manage the table bud_detail +/*! \file + * \brief class to manage the table bud_detail * */ diff --git a/include/class_bud_detail.php b/include/class_bud_detail.php index 3c0921d23..66b21be25 100644 --- a/include/class_bud_detail.php +++ b/include/class_bud_detail.php @@ -20,11 +20,17 @@ // Copyright Author Dany De Bontridder ddebontridder@yahoo.fr -/* !\file - */ -/*! \brief this class manage the table bud_detail +/*!\file + * + * \brief this class manage the table bud_detail * */ + + /*! + * \brief this class manage the table bud_detail + * + */ + require_once ('constant.php'); require_once ('postgres.php'); require_once ('class_dossier.php'); diff --git a/include/class_bud_detail_period.php b/include/class_bud_detail_period.php index 73300ae7f..2167e2e8c 100644 --- a/include/class_bud_detail_period.php +++ b/include/class_bud_detail_period.php @@ -20,7 +20,7 @@ // Copyright Author Dany De Bontridder ddebontridder@yahoo.fr -/* !\file +/*!\file */ /*! \brief diff --git a/include/class_bud_hypo.php b/include/class_bud_hypo.php index 7b75ce3bc..8716dbb78 100644 --- a/include/class_bud_hypo.php +++ b/include/class_bud_hypo.php @@ -20,11 +20,9 @@ // Copyright Author Dany De Bontridder ddebontridder@yahoo.fr -/* !\file - */ - -/*! \brief manage the database bud_hypo concerning the hypothese for - different hyp. +/*!\file + * \brief manage the database bud_hypo concerning the hypothese for + * different hyp. * */ require_once ('class_dossier.php'); diff --git a/include/constant.php b/include/constant.php index d7b672457..87ddfa3e3 100644 --- a/include/constant.php +++ b/include/constant.php @@ -36,7 +36,7 @@ define ("domaine",""); define ("MAX_COMPTE",4); -define ("DEBUG","false"); +define ("DEBUG","true"); // securite correspond a la table // action diff --git a/include/hypo.inc.php b/include/hypo.inc.php index 11c89ef43..51529e7f5 100644 --- a/include/hypo.inc.php +++ b/include/hypo.inc.php @@ -21,6 +21,5 @@ // Copyright Author Dany De Bontridder ddebontridder@yahoo.fr /* !\file + * \brief Manage the hypothese for the budget module */ - -/*! \brief Manage the hypothese for the budget module