From 9bc7e449c026a37958e1489c3e04d91607cd8c0d Mon Sep 17 00:00:00 2001 From: Dany De Bontridder Date: Wed, 21 Oct 2015 13:40:48 +0200 Subject: [PATCH] Documentation : tag for DOXYGEN misplaced with autoformatting --- html/test.php | 2 +- include/class/class_acc_ledger_sold.php | 18 ++++++++------- include/class/class_anc_grandlivre.php | 2 +- include/class/class_anc_key.php | 2 +- include/class/class_follow_up.php | 30 ++++++++++++------------- include/export/export_ledger_pdf.php | 2 +- include/manager.inc.php | 4 ++-- include/report.inc.php | 2 +- 8 files changed, 32 insertions(+), 30 deletions(-) diff --git a/html/test.php b/html/test.php index 819c8b0a8..9634180ba 100644 --- a/html/test.php +++ b/html/test.php @@ -18,7 +18,7 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ // Copyright Author Dany De Bontridder danydb@aevalys.eu -/* !\file +/*!\file * \brief this file let you debug and test the different functionnalities, there are 2 important things to do * It is only a quick and dirty testing. You should use a tool as PHPUNIT for the unit testing * diff --git a/include/class/class_acc_ledger_sold.php b/include/class/class_acc_ledger_sold.php index d13e81147..3a381ef2d 100644 --- a/include/class/class_acc_ledger_sold.php +++ b/include/class/class_acc_ledger_sold.php @@ -20,7 +20,8 @@ // Copyright Author Dany De Bontridder danydb@aevalys.eu -/* !\file +/*! + * \file * \brief class for the sold, herits from acc_ledger */ require_once NOALYSS_INCLUDE.'/lib/class_iselect.php'; @@ -42,7 +43,8 @@ require_once NOALYSS_INCLUDE.'/class/class_acc_ledger_fin.php'; require_once NOALYSS_INCLUDE.'/class/class_stock_goods.php'; require_once NOALYSS_INCLUDE.'/class/class_acc_ledger.php'; -/* !\brief Handle the ledger of sold, +/*! + * \brief Handle the ledger of sold, * * @exception throw an exception is something is wrong */ @@ -54,7 +56,7 @@ class Acc_Ledger_Sold extends Acc_Ledger { $this->type = 'VEN'; } - /* !\brief verify that the data are correct before inserting or confirming + /*!\brief verify that the data are correct before inserting or confirming * \param an array (usually $_POST) * \return String * \throw Exception if an error occurs @@ -219,7 +221,7 @@ class Acc_Ledger_Sold extends Acc_Ledger { } } - /* !\brief insert into the database, it calls first the verify function, + /*!\brief insert into the database, it calls first the verify function, * change the value of this->jr_id and this->jr_internal * * It generates the document if gen_invoice is set and save the middle of payment if any ($e_mp) * @@ -590,7 +592,7 @@ class Acc_Ledger_Sold extends Acc_Ledger { return $internal; } - /* ! + /*! * @brief show the summary of the operation and propose to save it * @param array contains normally $_POST. It proposes also to save * the Analytic accountancy @@ -904,7 +906,7 @@ EOF; return $r; } - /* !\brief the function extra info allows to + /*!\brief the function extra info allows to * - add a attachment * - generate an invoice * - insert extra info @@ -980,7 +982,7 @@ EOF; echo HtmlInput::submit('paid', _('Mise à jour paiement')); } - /* !\brief display the form for entering data for invoice, + /*!\brief display the form for entering data for invoice, * \param $p_array is null or you can put the predef operation or the $_POST * * \return HTML string @@ -1361,7 +1363,7 @@ EOF; $array['tot_vat'] = _('TVA Opération'); return $array; } - /* !\brief test function + /*!\brief test function */ static function test_me($p_string = '') { diff --git a/include/class/class_anc_grandlivre.php b/include/class/class_anc_grandlivre.php index 3cf02c466..8612686a1 100644 --- a/include/class/class_anc_grandlivre.php +++ b/include/class/class_anc_grandlivre.php @@ -116,7 +116,7 @@ class Anc_GrandLivre extends Anc_Print return $array; } - /* ! + /*! * \brief Show the button to export in PDF all the receipt * * \param $p_string extra hidden value diff --git a/include/class/class_anc_key.php b/include/class/class_anc_key.php index a1a99a2cd..4a5856494 100644 --- a/include/class/class_anc_key.php +++ b/include/class/class_anc_key.php @@ -30,7 +30,7 @@ require_once NOALYSS_INCLUDE.'/database/class_anc_key_sql.php'; class Anc_Key { - private $key; /* ! the distribution key */ + private $key; /*! the distribution key */ /** * Return the number of keys available. * Return the number of keys available for the ledger given in parameter diff --git a/include/class/class_follow_up.php b/include/class/class_follow_up.php index 4babe2371..ab4e5b6b2 100644 --- a/include/class/class_follow_up.php +++ b/include/class/class_follow_up.php @@ -64,21 +64,21 @@ require_once NOALYSS_INCLUDE.'/class/class_default_menu.php'; class Follow_Up { - var $db; /* !< $db database connexion */ - var $ag_timestamp; /* !< $ag_timestamp document date (ag_gestion.ag_timestamp) */ - var $dt_id; /* !< $dt_id type of the document (document_type.dt_id) */ - var $ag_state; /* !< $ag_state stage of the document (printed, send to client...) */ - var $d_number; /* !< $d_number number of the document */ - var $d_filename; /* !< $d_filename filename's document */ - var $d_mimetype; /* !< $d_mimetype document's filename */ - var $ag_title; /* !< $ag_title title document */ - var $f_id; /* !< $f_id_dest fiche id (From field ) */ - var $ag_ref; /* !< $ag_ref is the ref */ - var $ag_hour; /* !< $ag_hour is the hour of the meeting, action */ - var $ag_priority; /* !< $ag_priority is the priority 1 High, 2 medium, 3 low */ - var $ag_dest; /* !< $ag_dest person who is in charged */ - var $ag_contact; /* !< $ag_contact contact */ - var $ag_remind_date; /* !< $ag_contact contact */ + var $db; /*!< $db database connexion */ + var $ag_timestamp; /*!< $ag_timestamp document date (ag_gestion.ag_timestamp) */ + var $dt_id; /*!< $dt_id type of the document (document_type.dt_id) */ + var $ag_state; /*!< $ag_state stage of the document (printed, send to client...) */ + var $d_number; /*!< $d_number number of the document */ + var $d_filename; /*!< $d_filename filename's document */ + var $d_mimetype; /*!< $d_mimetype document's filename */ + var $ag_title; /*!< $ag_title title document */ + var $f_id; /*!< $f_id_dest fiche id (From field ) */ + var $ag_ref; /*!< $ag_ref is the ref */ + var $ag_hour; /*!< $ag_hour is the hour of the meeting, action */ + var $ag_priority; /*!< $ag_priority is the priority 1 High, 2 medium, 3 low */ + var $ag_dest; /*!< $ag_dest person who is in charged */ + var $ag_contact; /*!< $ag_contact contact */ + var $ag_remind_date; /*!< $ag_contact contact */ /** * @brief $operation string related operation diff --git a/include/export/export_ledger_pdf.php b/include/export/export_ledger_pdf.php index 1f9c2b505..17e49348f 100644 --- a/include/export/export_ledger_pdf.php +++ b/include/export/export_ledger_pdf.php @@ -20,7 +20,7 @@ // Copyright Author Dany De Bontridder danydb@aevalys.eu -/* ! \file +/*! \file * \brief Send a ledger in a pdf format * */ diff --git a/include/manager.inc.php b/include/manager.inc.php index 20e2eb804..eea029084 100644 --- a/include/manager.inc.php +++ b/include/manager.inc.php @@ -17,7 +17,7 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ // Copyright Author Dany De Bontridder danydb@aevalys.eu -/* !\brief include from supplier.inc.php and concerned only the supplier card and +/*!\brief include from supplier.inc.php and concerned only the supplier card and * the supplier category */ if (!defined('ALLOWED')) @@ -34,7 +34,7 @@ require_once NOALYSS_INCLUDE.'/class/class_fiche_def.php'; global $g_user; $low_action = (isset($_REQUEST['sb'])) ? $_REQUEST['sb'] : "list"; -/* ! \file +/*! \file * \brief Called from the module "Gestion" to manage the supplier */ $href = basename($_SERVER['PHP_SELF']); diff --git a/include/report.inc.php b/include/report.inc.php index d72aaf39f..e57ba05b4 100644 --- a/include/report.inc.php +++ b/include/report.inc.php @@ -18,7 +18,7 @@ */ // Copyright Author Dany De Bontridder danydb@aevalys.eu -/* ! \file +/*! \file * \brief handle your own report: create or view report */ if (!defined('ALLOWED'))