From 307bad1d2aa3466a9d2d134119f061bb80a33251 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20FRANCE?= Date: Wed, 11 Dec 2019 19:11:13 +0100 Subject: [PATCH 1/8] doxygen todo --- htdocs/adherents/subscription.php | 2 +- htdocs/admin/ticket.php | 2 +- htdocs/categories/class/categorie.class.php | 2 +- htdocs/comm/action/class/actioncomm.class.php | 2 +- htdocs/compta/cashcontrol/cashcontrol_card.php | 2 +- htdocs/compta/prelevement/class/rejetprelevement.class.php | 2 +- htdocs/compta/resultat/result.php | 2 +- htdocs/compta/stats/index.php | 2 +- htdocs/core/actions_massactions.inc.php | 2 +- htdocs/core/actions_sendmails.inc.php | 4 ++-- htdocs/core/class/commonobject.class.php | 6 +++--- htdocs/core/class/html.formfile.class.php | 2 +- htdocs/core/class/notify.class.php | 2 +- .../interface_50_modNotification_Notification.class.php | 2 +- htdocs/expensereport/class/expensereport.class.php | 4 ++-- htdocs/stripe/payment.php | 2 +- htdocs/user/class/user.class.php | 2 +- 17 files changed, 21 insertions(+), 21 deletions(-) diff --git a/htdocs/adherents/subscription.php b/htdocs/adherents/subscription.php index 3d1885799c3..1c6505a260b 100644 --- a/htdocs/adherents/subscription.php +++ b/htdocs/adherents/subscription.php @@ -898,7 +898,7 @@ if ($rowid > 0) 'moreattr' => 'maxlength="128"', ); } - // @TODO Add other extrafields mandatory for thirdparty creation + // @todo Add other extrafields mandatory for thirdparty creation print $form->formconfirm($_SERVER["PHP_SELF"]."?rowid=".$object->id, $langs->trans("CreateDolibarrThirdParty"), $langs->trans("ConfirmCreateThirdParty"), "confirm_create_thirdparty", $formquestion, 1); } diff --git a/htdocs/admin/ticket.php b/htdocs/admin/ticket.php index 98d77d47118..526c8785681 100644 --- a/htdocs/admin/ticket.php +++ b/htdocs/admin/ticket.php @@ -432,7 +432,7 @@ print ''; print ''; */ -// @TODO Use module notification instead... +// @todo Use module notification instead... // Email de réception des notifications print ''.$langs->trans("TicketEmailNotificationTo").''; diff --git a/htdocs/categories/class/categorie.class.php b/htdocs/categories/class/categorie.class.php index b9d58fc76f1..acbffa109a2 100644 --- a/htdocs/categories/class/categorie.class.php +++ b/htdocs/categories/class/categorie.class.php @@ -98,7 +98,7 @@ class Categorie extends CommonObject /** * @var array Foreign keys mapping from type string * - * @TODO Move to const array when PHP 5.6 will be our minimum target + * @todo Move to const array when PHP 5.6 will be our minimum target */ protected $MAP_CAT_FK = array( 'product' => 'product', diff --git a/htdocs/comm/action/class/actioncomm.class.php b/htdocs/comm/action/class/actioncomm.class.php index 69f748412a1..38af9bfd4fd 100644 --- a/htdocs/comm/action/class/actioncomm.class.php +++ b/htdocs/comm/action/class/actioncomm.class.php @@ -1112,7 +1112,7 @@ class ActionComm extends CommonObject /** * Load all objects with filters. - * @TODO WARNING: This make a fetch on all records instead of making one request with a join. + * @todo WARNING: This make a fetch on all records instead of making one request with a join. * * @param DoliDb $db Database handler * @param int $socid Filter by thirdparty diff --git a/htdocs/compta/cashcontrol/cashcontrol_card.php b/htdocs/compta/cashcontrol/cashcontrol_card.php index ef88c586ede..9f2a69ff6c5 100644 --- a/htdocs/compta/cashcontrol/cashcontrol_card.php +++ b/htdocs/compta/cashcontrol/cashcontrol_card.php @@ -248,7 +248,7 @@ if ($action == "create" || $action == "start") $vartouse = 'CASHDESK_ID_BANKACCOUNT_CASH'.$terminaltouse; $bankid = $conf->global->$vartouse; // This value is ok for 'Terminal 0' for module 'CashDesk' and 'TakePos' (they manage only 1 terminal) // Hook to get the good bank id according to posmodule and posnumber. - // @TODO add hook here + // @todo add hook here if ($bankid > 0) { diff --git a/htdocs/compta/prelevement/class/rejetprelevement.class.php b/htdocs/compta/prelevement/class/rejetprelevement.class.php index 851a6450b8b..740a1e47784 100644 --- a/htdocs/compta/prelevement/class/rejetprelevement.class.php +++ b/htdocs/compta/prelevement/class/rejetprelevement.class.php @@ -280,7 +280,7 @@ class RejetPrelevement * * @param int $amounts If you want to get the amount of the order for each invoice * @return array Array List of invoices related to the withdrawal line - * @TODO A withdrawal line is today linked to one and only one invoice. So the function should return only one object ? + * @todo A withdrawal line is today linked to one and only one invoice. So the function should return only one object ? */ private function getListInvoices($amounts = 0) { diff --git a/htdocs/compta/resultat/result.php b/htdocs/compta/resultat/result.php index 9af5a559f5e..6e91ef53e2b 100644 --- a/htdocs/compta/resultat/result.php +++ b/htdocs/compta/resultat/result.php @@ -420,7 +420,7 @@ elseif ($modecompta=="BOOKKEEPING") foreach ($cpts as $i => $cpt) // Loop on each account. { // We make 1 loop for each account because we may want detail per account. - // @TODO Optimize to ask a 'group by' account and a filter with account in (..., ...) in request + // @todo Optimize to ask a 'group by' account and a filter with account in (..., ...) in request // Each month $resultN = 0; diff --git a/htdocs/compta/stats/index.php b/htdocs/compta/stats/index.php index ac3e800e6e4..df9ac7d3a7e 100644 --- a/htdocs/compta/stats/index.php +++ b/htdocs/compta/stats/index.php @@ -194,7 +194,7 @@ elseif ($modecompta=="BOOKKEEPING") $sql = "SELECT date_format(b.doc_date,'%Y-%m') as dm, sum(b.credit) as amount_ttc"; $sql.= " FROM ".MAIN_DB_PREFIX."accounting_bookkeeping as b, ".MAIN_DB_PREFIX."accounting_journal as aj"; $sql.= " WHERE b.entity = ".$conf->entity; - $sql.= " AND b.code_journal = aj.code AND aj.nature = 2" ; // @TODO currently count amount in sale journal, but we need to define a category group for turnover + $sql.= " AND b.code_journal = aj.code AND aj.nature = 2" ; // @todo currently count amount in sale journal, but we need to define a category group for turnover } $sql.= " GROUP BY dm"; diff --git a/htdocs/core/actions_massactions.inc.php b/htdocs/core/actions_massactions.inc.php index 35009811fe2..f379cd0c82f 100644 --- a/htdocs/core/actions_massactions.inc.php +++ b/htdocs/core/actions_massactions.inc.php @@ -1280,7 +1280,7 @@ if (!$error && ($massaction == 'delete' || ($action == 'delete' && $confirm == ' } // Generate document foreach object according to model linked to object -// @TODO : propose model selection +// @todo : propose model selection if (!$error && $massaction == 'generate_doc' && $permissiontoread) { $db->begin(); diff --git a/htdocs/core/actions_sendmails.inc.php b/htdocs/core/actions_sendmails.inc.php index f490397754d..3f13eec2b34 100644 --- a/htdocs/core/actions_sendmails.inc.php +++ b/htdocs/core/actions_sendmails.inc.php @@ -431,7 +431,7 @@ if (($action == 'send' || $action == 'relance') && ! $_POST['addfile'] && ! $_PO $object->socid = $sendtosocid; // To link to a company $object->sendtoid = $sendtoid; // To link to contact addresses. This is an array. $object->actiontypecode = $actiontypecode; // Type of event ('AC_OTH', 'AC_OTH_AUTO', 'AC_XXX'...) - $object->actionmsg = $actionmsg; // Long text (@TODO Replace this with $message, we already have details of email in dedicated properties) + $object->actionmsg = $actionmsg; // Long text (@todo Replace this with $message, we already have details of email in dedicated properties) $object->actionmsg2 = $actionmsg2; // Short text ($langs->transnoentities('MailSentBy')...); $object->trackid = $trackid; @@ -444,7 +444,7 @@ if (($action == 'send' || $action == 'relance') && ! $_POST['addfile'] && ! $_PO $object->sendtouserid = $sendtouserid; } - $object->email_msgid = $mailfile->msgid; // @TODO Set msgid into $mailfile after sending + $object->email_msgid = $mailfile->msgid; // @todo Set msgid into $mailfile after sending $object->email_from = $from; $object->email_subject = $subject; $object->email_to = $sendto; diff --git a/htdocs/core/class/commonobject.class.php b/htdocs/core/class/commonobject.class.php index 544063bc4c8..25588323103 100644 --- a/htdocs/core/class/commonobject.class.php +++ b/htdocs/core/class/commonobject.class.php @@ -2598,7 +2598,7 @@ abstract class CommonObject */ public function updateRangOfLine($rowid, $rang) { - $fieldposition = 'rang'; // @TODO Rename 'rang' into 'position' + $fieldposition = 'rang'; // @todo Rename 'rang' into 'position' if (in_array($this->table_element_line, array('bom_bomline', 'ecm_files', 'emailcollector_emailcollectoraction'))) $fieldposition = 'position'; $sql = 'UPDATE '.MAIN_DB_PREFIX.$this->table_element_line.' SET '.$fieldposition.' = '.$rang; @@ -4883,7 +4883,7 @@ abstract class CommonObject /** * Build thumb - * @TODO Move this into files.lib.php + * @todo Move this into files.lib.php * * @param string $file Path file in UTF8 to original file to create thumbs from. * @return void @@ -6607,7 +6607,7 @@ abstract class CommonObject // Show only the key field in params if (is_array($params) && array_key_exists('onlykey', $params) && $key != $params['onlykey']) continue; - // @TODO Add test also on 'enabled' (different than 'list' that is 'visibility') + // @todo Add test also on 'enabled' (different than 'list' that is 'visibility') $enabled = 1; $visibility = 1; diff --git a/htdocs/core/class/html.formfile.class.php b/htdocs/core/class/html.formfile.class.php index 0352700d91a..c78fe06693b 100644 --- a/htdocs/core/class/html.formfile.class.php +++ b/htdocs/core/class/html.formfile.class.php @@ -971,7 +971,7 @@ class FormFile } // Get list of files starting with name of ref (but not followed by "-" to discard uploaded files and get only generated files) - // @TODO Why not showing by default all files by just removing the '[^\-]+' at end of regex ? + // @todo Why not showing by default all files by just removing the '[^\-]+' at end of regex ? if (!empty($conf->global->MAIN_SHOW_ALL_FILES_ON_DOCUMENT_TOOLTIP)) { $filterforfilesearch = preg_quote(basename($modulesubdir), '/'); diff --git a/htdocs/core/class/notify.class.php b/htdocs/core/class/notify.class.php index 12be3854ed6..7a3508c7d2f 100644 --- a/htdocs/core/class/notify.class.php +++ b/htdocs/core/class/notify.class.php @@ -65,7 +65,7 @@ class Notify // Les codes actions sont definis dans la table llx_notify_def // codes actions supported are - // @TODO defined also into interface_50_modNotificiation_Notificiation.class.php + // @todo defined also into interface_50_modNotificiation_Notificiation.class.php public $arrayofnotifsupported = array( 'BILL_VALIDATE', 'BILL_PAYED', diff --git a/htdocs/core/triggers/interface_50_modNotification_Notification.class.php b/htdocs/core/triggers/interface_50_modNotification_Notification.class.php index f467040a00d..490727f9521 100644 --- a/htdocs/core/triggers/interface_50_modNotification_Notification.class.php +++ b/htdocs/core/triggers/interface_50_modNotification_Notification.class.php @@ -44,7 +44,7 @@ class InterfaceNotification extends DolibarrTriggers */ public $picto = 'email'; - // @TODO Defined also into notify.class.php) + // @todo Defined also into notify.class.php) public $listofmanagedevents=array( 'BILL_VALIDATE', 'BILL_PAYED', diff --git a/htdocs/expensereport/class/expensereport.class.php b/htdocs/expensereport/class/expensereport.class.php index ad21603efce..79ea7552237 100644 --- a/htdocs/expensereport/class/expensereport.class.php +++ b/htdocs/expensereport/class/expensereport.class.php @@ -2712,8 +2712,8 @@ class ExpenseReportLine if (!empty($this->id)) $sql.= ' AND d.rowid <> '.$this->id; $sql .= ' AND d.fk_c_type_fees = '.$rule->fk_c_type_fees; if ($mode == 'day' || $mode == 'EX_DAY') $sql .= ' AND d.date = \''.dol_print_date($this->date, '%Y-%m-%d').'\''; - elseif ($mode == 'mon' || $mode == 'EX_MON') $sql .= ' AND DATE_FORMAT(d.date, \'%Y-%m\') = \''.dol_print_date($this->date, '%Y-%m').'\''; // @TODO DATE_FORMAT is forbidden - elseif ($mode == 'year' || $mode == 'EX_YEA') $sql .= ' AND DATE_FORMAT(d.date, \'%Y\') = \''.dol_print_date($this->date, '%Y').'\''; // @TODO DATE_FORMAT is forbidden + elseif ($mode == 'mon' || $mode == 'EX_MON') $sql .= ' AND DATE_FORMAT(d.date, \'%Y-%m\') = \''.dol_print_date($this->date, '%Y-%m').'\''; // @todo DATE_FORMAT is forbidden + elseif ($mode == 'year' || $mode == 'EX_YEA') $sql .= ' AND DATE_FORMAT(d.date, \'%Y\') = \''.dol_print_date($this->date, '%Y').'\''; // @todo DATE_FORMAT is forbidden dol_syslog('ExpenseReportLine::getExpAmount'); diff --git a/htdocs/stripe/payment.php b/htdocs/stripe/payment.php index 4692687220a..7e4abfb5692 100644 --- a/htdocs/stripe/payment.php +++ b/htdocs/stripe/payment.php @@ -28,7 +28,7 @@ /** * \file htdocs/stripe/payment.php * \ingroup stripe - * \brief Payment page for customers invoices. @TODO Seems deprecated and bugged and not used (no link to this page) ! + * \brief Payment page for customers invoices. @todo Seems deprecated and bugged and not used (no link to this page) ! */ // Load Dolibarr environment diff --git a/htdocs/user/class/user.class.php b/htdocs/user/class/user.class.php index ffb8c15e3c3..7ade356a360 100644 --- a/htdocs/user/class/user.class.php +++ b/htdocs/user/class/user.class.php @@ -1971,7 +1971,7 @@ class User extends CommonObject * * @param User $user Object user that send email * @param string $password New password - * @param int $changelater 0=Send clear passwod into email, 1=Change password only after clicking on confirm email. @TODO Add method 2 = Send link to reset password + * @param int $changelater 0=Send clear passwod into email, 1=Change password only after clicking on confirm email. @todo Add method 2 = Send link to reset password * @return int < 0 si erreur, > 0 si ok */ public function send_password($user, $password = '', $changelater = 0) From 1733aa18df996d6a9a7fb70d4c01bfaf3386225d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20FRANCE?= Date: Wed, 11 Dec 2019 19:57:10 +0100 Subject: [PATCH 2/8] fix phpcs --- htdocs/margin/tabs/productMargins.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/htdocs/margin/tabs/productMargins.php b/htdocs/margin/tabs/productMargins.php index 3b53cea29d2..f73dab4136d 100644 --- a/htdocs/margin/tabs/productMargins.php +++ b/htdocs/margin/tabs/productMargins.php @@ -243,7 +243,7 @@ if ($id > 0 || !empty($ref)) print ''.price(price2num($cumul_qty, 'MT'))."\n"; print ''.price(price2num($totalMargin, 'MT'))."\n"; if (!empty($conf->global->DISPLAY_MARGIN_RATES)) - print ''.(($marginRate === '') ? 'n/a' : price(price2num($marginRate, 'MT'))."\n"; + print ''.(($marginRate === '') ? 'n/a' : price(price2num($marginRate, 'MT')))."\n"; if (!empty($conf->global->DISPLAY_MARK_RATES)) print "".(($markRate === '') ? 'n/a' : price(price2num($markRate, 'MT'))."%")."\n"; print ' '; From b59d93c8d7a12d5be69ab653b408375bb25c2a04 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20FRANCE?= Date: Wed, 11 Dec 2019 20:11:53 +0100 Subject: [PATCH 3/8] doxygen --- htdocs/loan/calcmens.php | 5 +++-- .../mymodule/doc/doc_generic_myobject_odt.modules.php | 2 +- htdocs/mrp/ajax/ajax_bom.php | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/htdocs/loan/calcmens.php b/htdocs/loan/calcmens.php index e31353b3726..b65aa41c4d4 100644 --- a/htdocs/loan/calcmens.php +++ b/htdocs/loan/calcmens.php @@ -18,8 +18,9 @@ */ /** - * \file tvi/ajax/list.php - * \brief File to return datables output + * \file htdocs/loan/calcmens.php + * \ingroup loan + * \brief File to calculate loan monthly payments */ if (!defined('NOTOKENRENEWAL')) define('NOTOKENRENEWAL', '1'); // Disables token renewal diff --git a/htdocs/modulebuilder/template/core/modules/mymodule/doc/doc_generic_myobject_odt.modules.php b/htdocs/modulebuilder/template/core/modules/mymodule/doc/doc_generic_myobject_odt.modules.php index db6462eb90a..a1314d54226 100644 --- a/htdocs/modulebuilder/template/core/modules/mymodule/doc/doc_generic_myobject_odt.modules.php +++ b/htdocs/modulebuilder/template/core/modules/mymodule/doc/doc_generic_myobject_odt.modules.php @@ -22,7 +22,7 @@ */ /** - * \file htdocs/core/modules/commande/doc/doc_generic_myobject_odt.modules.php + * \file htdocs/core/modules/mymodule/doc/doc_generic_myobject_odt.modules.php * \ingroup mymodule * \brief File of class to build ODT documents for myobjects */ diff --git a/htdocs/mrp/ajax/ajax_bom.php b/htdocs/mrp/ajax/ajax_bom.php index 15b70ae17c9..19fea01aa60 100644 --- a/htdocs/mrp/ajax/ajax_bom.php +++ b/htdocs/mrp/ajax/ajax_bom.php @@ -16,7 +16,7 @@ */ /** - * \file htdocs/mrp/ajax/ajax.php + * \file htdocs/mrp/ajax/ajax_bom.php * \brief Ajax search component for Mrp. It get BOM content. */ From c98ab917ddd8ef8e0a5940edab63f8089dcb4d5f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20FRANCE?= Date: Wed, 11 Dec 2019 20:33:58 +0100 Subject: [PATCH 4/8] doxygen --- htdocs/admin/bank_extrafields.php | 17 ++++------ htdocs/admin/commande.php | 2 +- htdocs/api/admin/explorer.php | 31 +++++++++---------- .../admin/facture_cust_extrafields.php | 20 ++++++------ .../admin/facture_rec_cust_extrafields.php | 20 ++++++------ .../admin/facturedet_cust_extrafields.php | 20 ++++++------ .../admin/facturedet_rec_cust_extrafields.php | 20 ++++++------ 7 files changed, 61 insertions(+), 69 deletions(-) diff --git a/htdocs/admin/bank_extrafields.php b/htdocs/admin/bank_extrafields.php index 5daafd17fb9..75fd269abc9 100644 --- a/htdocs/admin/bank_extrafields.php +++ b/htdocs/admin/bank_extrafields.php @@ -87,12 +87,9 @@ if ($action != 'create' && $action != 'edit') } -/* ************************************************************************** */ -/* */ -/* Creation of an optional field - /* */ -/* ************************************************************************** */ - +/* + * Creation of an optional field + */ if ($action == 'create') { print '
'; @@ -101,11 +98,9 @@ if ($action == 'create') require DOL_DOCUMENT_ROOT.'/core/tpl/admin_extrafields_add.tpl.php'; } -/* ************************************************************************** */ -/* */ -/* Edition of an optional field */ -/* */ -/* ************************************************************************** */ +/* + * Edition of an optional field + */ if ($action == 'edit' && ! empty($attrname)) { print "
"; diff --git a/htdocs/admin/commande.php b/htdocs/admin/commande.php index 3f064e22dfb..895c7d6618d 100644 --- a/htdocs/admin/commande.php +++ b/htdocs/admin/commande.php @@ -587,8 +587,8 @@ if (!empty($conf->global->SHIPPABLE_ORDER_ICON_IN_LIST)) { print ''; print ''; -/* Seems to be not so used. So kept hidden for the moment to avoid dangerous options inflation. /* +// Seems to be not so used. So kept hidden for the moment to avoid dangerous options inflation. // Ask for payment bank during order if ($conf->banque->enabled) { diff --git a/htdocs/api/admin/explorer.php b/htdocs/api/admin/explorer.php index 4e92873c384..ac267d29bc3 100644 --- a/htdocs/api/admin/explorer.php +++ b/htdocs/api/admin/explorer.php @@ -132,24 +132,21 @@ foreach ($modulesdir as $dir) $classname = ucfirst($classname); require_once $dir_part.$file_searched; - if (class_exists($classname)) - { - dol_syslog("Found API classname=".$classname); - $api->r->addAPIClass($classname,''); + // if (class_exists($classname)) + // { + // dol_syslog("Found API classname=".$classname); + // $api->r->addAPIClass($classname,''); + // require_once DOL_DOCUMENT_ROOT.'/includes/restler/framework/Luracast/Restler/Routes.php'; + // $tmpclass = new ReflectionClass($classname); + // try { + // $classMetadata = CommentParser::parse($tmpclass->getDocComment()); + // } catch (Exception $e) { + // throw new RestException(500, "Error while parsing comments of `$classname` class. " . $e->getMessage()); + // } - /* - require_once DOL_DOCUMENT_ROOT.'/includes/restler/framework/Luracast/Restler/Routes.php'; - $tmpclass = new ReflectionClass($classname); - try { - $classMetadata = CommentParser::parse($tmpclass->getDocComment()); - } catch (Exception $e) { - throw new RestException(500, "Error while parsing comments of `$classname` class. " . $e->getMessage()); - }*/ - - //$listofapis[]=array('classname'=>$classname, 'fullpath'=>$file_searched); - /* } - + // //$listofapis[]=array('classname'=>$classname, 'fullpath'=>$file_searched); + // } }*/ } } @@ -160,7 +157,7 @@ foreach ($modulesdir as $dir) } //var_dump($listofapis); -$listofapis = Routes::toArray(); // TODO api for "status" is lost here +$listofapis = Routes::toArray(); // @todo api for "status" is lost here //var_dump($listofapis); diff --git a/htdocs/compta/facture/admin/facture_cust_extrafields.php b/htdocs/compta/facture/admin/facture_cust_extrafields.php index 127e38a0ddf..c9d4d906280 100644 --- a/htdocs/compta/facture/admin/facture_cust_extrafields.php +++ b/htdocs/compta/facture/admin/facture_cust_extrafields.php @@ -85,11 +85,11 @@ if ($action != 'create' && $action != 'edit') } -/* ************************************************************************** */ -/* */ -/* Creation of an optional field */ -/* */ -/* ************************************************************************** */ +/* + * + * Creation of an optional field + * + */ if ($action == 'create') { @@ -99,11 +99,11 @@ if ($action == 'create') require DOL_DOCUMENT_ROOT.'/core/tpl/admin_extrafields_add.tpl.php'; } -/* ************************************************************************** */ -/* */ -/* Edition of an optional field */ -/* */ -/* ************************************************************************** */ +/* + * + * Edition of an optional field + * + */ if ($action == 'edit' && ! empty($attrname)) { $langs->load("members"); diff --git a/htdocs/compta/facture/admin/facture_rec_cust_extrafields.php b/htdocs/compta/facture/admin/facture_rec_cust_extrafields.php index b8fb7ade572..08a2280ff1c 100644 --- a/htdocs/compta/facture/admin/facture_rec_cust_extrafields.php +++ b/htdocs/compta/facture/admin/facture_rec_cust_extrafields.php @@ -86,11 +86,11 @@ if ($action != 'create' && $action != 'edit') } -/* ************************************************************************** */ -/* */ -/* Creation of an optional field */ -/* */ -/* ************************************************************************** */ +/* + * + * Creation of an optional field + * + */ if ($action == 'create') { @@ -100,11 +100,11 @@ if ($action == 'create') require DOL_DOCUMENT_ROOT.'/core/tpl/admin_extrafields_add.tpl.php'; } -/* ************************************************************************** */ -/* */ -/* Edition of an optional field */ -/* */ -/* ************************************************************************** */ +/* + * + * Edition of an optional field + * + */ if ($action == 'edit' && ! empty($attrname)) { $langs->load("members"); diff --git a/htdocs/compta/facture/admin/facturedet_cust_extrafields.php b/htdocs/compta/facture/admin/facturedet_cust_extrafields.php index 07115733efb..fad5ec0e7a2 100644 --- a/htdocs/compta/facture/admin/facturedet_cust_extrafields.php +++ b/htdocs/compta/facture/admin/facturedet_cust_extrafields.php @@ -86,11 +86,11 @@ if ($action != 'create' && $action != 'edit') } -/* ************************************************************************** */ -/* */ -/* Creation d'un champ optionnel -/* */ -/* ************************************************************************** */ +/* + * + * Creation d'un champ optionnel + * + */ if ($action == 'create') { @@ -100,11 +100,11 @@ if ($action == 'create') require DOL_DOCUMENT_ROOT.'/core/tpl/admin_extrafields_add.tpl.php'; } -/* ************************************************************************** */ -/* */ -/* Edition d'un champ optionnel */ -/* */ -/* ************************************************************************** */ +/* + * + * Edition d'un champ optionnel + * + */ if ($action == 'edit' && ! empty($attrname)) { print "
"; diff --git a/htdocs/compta/facture/admin/facturedet_rec_cust_extrafields.php b/htdocs/compta/facture/admin/facturedet_rec_cust_extrafields.php index cd73063e1e6..133102fc282 100644 --- a/htdocs/compta/facture/admin/facturedet_rec_cust_extrafields.php +++ b/htdocs/compta/facture/admin/facturedet_rec_cust_extrafields.php @@ -86,11 +86,11 @@ if ($action != 'create' && $action != 'edit') } -/* ************************************************************************** */ -/* */ -/* Creation d'un champ optionnel -/* */ -/* ************************************************************************** */ +/* + * + * Creation d'un champ optionnel + * + */ if ($action == 'create') { @@ -100,11 +100,11 @@ if ($action == 'create') require DOL_DOCUMENT_ROOT.'/core/tpl/admin_extrafields_add.tpl.php'; } -/* ************************************************************************** */ -/* */ -/* Edition d'un champ optionnel */ -/* */ -/* ************************************************************************** */ +/* + * + * Edition d'un champ optionnel + * + */ if ($action == 'edit' && ! empty($attrname)) { print "
"; From 66805a502ae977557ff56bec0274a76b765529c0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20FRANCE?= Date: Wed, 11 Dec 2019 22:53:57 +0100 Subject: [PATCH 5/8] doxygen --- build/doxygen/dolibarr-doxygen-filter.pl | 4 ++-- .../bookkeeping/thirdparty_lettering_supplier.php | 2 +- htdocs/admin/commande_fournisseur_dispatch_extrafields.php | 2 +- htdocs/asset/admin/assets_extrafields.php | 6 +++--- htdocs/compta/paiement/class/cpaiement.class.php | 2 +- htdocs/core/class/html.formticket.class.php | 2 +- htdocs/user/admin/group_extrafields.php | 6 +++--- htdocs/user/admin/user_extrafields.php | 6 +++--- 8 files changed, 15 insertions(+), 15 deletions(-) diff --git a/build/doxygen/dolibarr-doxygen-filter.pl b/build/doxygen/dolibarr-doxygen-filter.pl index c3ab35cb8d2..9233bd9e77d 100755 --- a/build/doxygen/dolibarr-doxygen-filter.pl +++ b/build/doxygen/dolibarr-doxygen-filter.pl @@ -8,7 +8,7 @@ # Usage: dolibarr-doxygen-filter.pl pathtofilefromdolibarrroot $file=$ARGV[0]; -if (! $file) +if (! $file) { print "Usage: dolibarr-doxygen-filter.pl pathtofilefromdolibarrroot\n"; exit; @@ -75,7 +75,7 @@ while () { $insidedquote=0; } - } + } } } $ignore=""; diff --git a/htdocs/accountancy/bookkeeping/thirdparty_lettering_supplier.php b/htdocs/accountancy/bookkeeping/thirdparty_lettering_supplier.php index 338c795b4b2..61e5e34da99 100644 --- a/htdocs/accountancy/bookkeeping/thirdparty_lettering_supplier.php +++ b/htdocs/accountancy/bookkeeping/thirdparty_lettering_supplier.php @@ -21,7 +21,7 @@ */ /** - * \file htdocs/accountancy/bookkeeping/thirdparty_lettrage_supplier.php + * \file htdocs/accountancy/bookkeeping/thirdparty_lettering_supplier.php * \ingroup Accountancy (Double entries) * \brief Tab to setup lettering */ diff --git a/htdocs/admin/commande_fournisseur_dispatch_extrafields.php b/htdocs/admin/commande_fournisseur_dispatch_extrafields.php index f06c4412207..900d66c73b5 100644 --- a/htdocs/admin/commande_fournisseur_dispatch_extrafields.php +++ b/htdocs/admin/commande_fournisseur_dispatch_extrafields.php @@ -25,7 +25,7 @@ */ /** - * \file htdocs/admin/commandefournisseurdispatch_extrafields.php + * \file htdocs/admin/commande_fournisseur_dispatch_extrafields.php * \ingroup reception * \brief Page to setup extra fields of reception */ diff --git a/htdocs/asset/admin/assets_extrafields.php b/htdocs/asset/admin/assets_extrafields.php index 60147cf512b..d4ae2bd2930 100644 --- a/htdocs/asset/admin/assets_extrafields.php +++ b/htdocs/asset/admin/assets_extrafields.php @@ -17,9 +17,9 @@ */ /** - * \file htdocs/asset/admin/asset_extrafields.php - * \ingroup asset - * \brief Page to setup extra fields of assets + * \file htdocs/asset/admin/assets_extrafields.php + * \ingroup asset + * \brief Page to setup extra fields of assets */ require '../../main.inc.php'; diff --git a/htdocs/compta/paiement/class/cpaiement.class.php b/htdocs/compta/paiement/class/cpaiement.class.php index 4363f39216f..9a0e4b6c5fe 100644 --- a/htdocs/compta/paiement/class/cpaiement.class.php +++ b/htdocs/compta/paiement/class/cpaiement.class.php @@ -19,7 +19,7 @@ */ /** - * \file htdocs/compat/paiement/class/cpaiement.class.php + * \file htdocs/compta/paiement/class/cpaiement.class.php * \ingroup facture * \brief This file is to manage CRUD function of type of payments */ diff --git a/htdocs/core/class/html.formticket.class.php b/htdocs/core/class/html.formticket.class.php index 117af9e8f19..90bbe9d0449 100644 --- a/htdocs/core/class/html.formticket.class.php +++ b/htdocs/core/class/html.formticket.class.php @@ -18,7 +18,7 @@ */ /** - * \file ticket/class/html.ticket.class.php + * \file htdocs/core/class/html.formticket.class.php * \ingroup ticket * \brief Fichier de la classe permettant la generation du formulaire html d'envoi de mail unitaire */ diff --git a/htdocs/user/admin/group_extrafields.php b/htdocs/user/admin/group_extrafields.php index a934d6cd74c..69b56cf9261 100644 --- a/htdocs/user/admin/group_extrafields.php +++ b/htdocs/user/admin/group_extrafields.php @@ -20,9 +20,9 @@ */ /** - * \file htdocs/adherents/admin/adherent_extrafields.php - * \ingroup member - * \brief Page to setup extra fields of members + * \file htdocs/user/admin/user_extrafields.php + * \ingroup user + * \brief Page to setup extra fields of users */ require '../../main.inc.php'; diff --git a/htdocs/user/admin/user_extrafields.php b/htdocs/user/admin/user_extrafields.php index 712d7318391..1f87b5fbe90 100644 --- a/htdocs/user/admin/user_extrafields.php +++ b/htdocs/user/admin/user_extrafields.php @@ -19,9 +19,9 @@ */ /** - * \file htdocs/adherents/admin/adherent_extrafields.php - * \ingroup member - * \brief Page to setup extra fields of members + * \file htdocs/user/admin/user_extrafields.php + * \ingroup user + * \brief Page to setup extra fields of users */ require '../../main.inc.php'; From 12f84d82543cacb10f6faec8cbe6b3a3800a28a1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20FRANCE?= Date: Wed, 11 Dec 2019 23:04:27 +0100 Subject: [PATCH 6/8] doxygen --- htdocs/core/db/sqlite3.class.php | 2 +- htdocs/core/lib/functionsnumtoword.lib.php | 2 +- .../core/modules/modEmailCollector.class.php | 18 +++++++++--------- htdocs/fichinter/class/fichinterrec.class.php | 6 +++--- htdocs/takepos/send.php | 2 +- htdocs/user/admin/group_extrafields.php | 2 +- 6 files changed, 16 insertions(+), 16 deletions(-) diff --git a/htdocs/core/db/sqlite3.class.php b/htdocs/core/db/sqlite3.class.php index af529e97fae..20a5f9728cb 100644 --- a/htdocs/core/db/sqlite3.class.php +++ b/htdocs/core/db/sqlite3.class.php @@ -21,7 +21,7 @@ */ /** - * \file htdocs/core/db/sqlite.class.php + * \file htdocs/core/db/sqlite3.class.php * \brief Class file to manage Dolibarr database access for a SQLite database */ diff --git a/htdocs/core/lib/functionsnumtoword.lib.php b/htdocs/core/lib/functionsnumtoword.lib.php index a0ae9bb3692..5fbb799b7dc 100644 --- a/htdocs/core/lib/functionsnumtoword.lib.php +++ b/htdocs/core/lib/functionsnumtoword.lib.php @@ -17,7 +17,7 @@ * or see https://www.gnu.org/ */ /** - * \file htdocs/core/lib/functionsnumbertoword.lib.php + * \file htdocs/core/lib/functionsnumtoword.lib.php * \brief A set of functions for Dolibarr * This file contains all frequently used functions. */ diff --git a/htdocs/core/modules/modEmailCollector.class.php b/htdocs/core/modules/modEmailCollector.class.php index 092aeb3fa3a..0b02576f5d4 100644 --- a/htdocs/core/modules/modEmailCollector.class.php +++ b/htdocs/core/modules/modEmailCollector.class.php @@ -16,18 +16,18 @@ */ /** - * \defgroup dav Module dav - * \brief dav module descriptor. + * \defgroup emailcollector Module emailcollector + * \brief emailcollector module descriptor. * - * \file htdocs/dav/core/modules/modDav.class.php - * \ingroup dav - * \brief Description and activation file for module dav + * \file htdocs/emailcollector/core/modules/modEmailCollector.class.php + * \ingroup emailcollector + * \brief Description and activation file for module emailcollector */ include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php'; /** - * Description and activation class for module dav + * Description and activation class for module emailcollector */ class modEmailCollector extends DolibarrModules { @@ -108,10 +108,10 @@ class modEmailCollector extends DolibarrModules ); - if (! isset($conf->dav) || ! isset($conf->dav->enabled)) + if (! isset($conf->emailcollector) || ! isset($conf->emailcollector->enabled)) { - $conf->dav=new stdClass(); - $conf->dav->enabled=0; + $conf->emailcollector=new stdClass(); + $conf->emailcollector->enabled=0; } diff --git a/htdocs/fichinter/class/fichinterrec.class.php b/htdocs/fichinter/class/fichinterrec.class.php index d4f526d9847..92a42d1ffdf 100644 --- a/htdocs/fichinter/class/fichinterrec.class.php +++ b/htdocs/fichinter/class/fichinterrec.class.php @@ -23,9 +23,9 @@ */ /** - * \file fichinterrec/class/fichinter-rec.class.php - * \ingroup facture - * \brief Fichier de la classe des factures recurentes + * \file htdocs/fichinter/class/fichinterrec.class.php + * \ingroup facture + * \brief Fichier de la classe des factures recurentes */ require_once DOL_DOCUMENT_ROOT.'/core/class/notify.class.php'; diff --git a/htdocs/takepos/send.php b/htdocs/takepos/send.php index 7c5676c5a1f..268fa6f6670 100644 --- a/htdocs/takepos/send.php +++ b/htdocs/takepos/send.php @@ -16,7 +16,7 @@ */ /** - * \file htdocs/takepos/printsend.php + * \file htdocs/takepos/send.php * \ingroup takepos * \brief Page with the content of the popup to enter payments */ diff --git a/htdocs/user/admin/group_extrafields.php b/htdocs/user/admin/group_extrafields.php index 69b56cf9261..92be17dcd47 100644 --- a/htdocs/user/admin/group_extrafields.php +++ b/htdocs/user/admin/group_extrafields.php @@ -20,7 +20,7 @@ */ /** - * \file htdocs/user/admin/user_extrafields.php + * \file htdocs/user/admin/group_extrafields.php * \ingroup user * \brief Page to setup extra fields of users */ From f30d1394ddcbf8970d42dd6ddb7fe44db8eb7f0e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20FRANCE?= Date: Wed, 11 Dec 2019 23:30:54 +0100 Subject: [PATCH 7/8] doxygen --- htdocs/don/admin/donation.php | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/htdocs/don/admin/donation.php b/htdocs/don/admin/donation.php index 9b1c08704b6..b5c775207ba 100644 --- a/htdocs/don/admin/donation.php +++ b/htdocs/don/admin/donation.php @@ -21,9 +21,9 @@ */ /** - * \file htdocs/don/admin/dons.php - * \ingroup donations - * \brief Page to setup the donation module + * \file htdocs/don/admin/donation.php + * \ingroup donations + * \brief Page to setup the donation module */ require '../../main.inc.php'; require_once DOL_DOCUMENT_ROOT . '/core/lib/admin.lib.php'; From 9357bfd98e7d763f7a771148c73d899689a10793 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20FRANCE?= Date: Thu, 12 Dec 2019 08:17:14 +0100 Subject: [PATCH 8/8] doxygen --- htdocs/compta/bank/various_payment/card.php | 2 +- htdocs/core/boxes/box_birthdays_members.php | 4 ++-- htdocs/core/boxes/box_last_ticket.php | 2 +- htdocs/core/boxes/box_project.php | 2 +- htdocs/core/class/fileupload.class.php | 2 +- htdocs/core/class/workboardresponse.class.php | 2 +- htdocs/product/class/product.class.php | 2 +- htdocs/zapier/class/api_zapier.class.php | 18 +++++++++--------- 8 files changed, 17 insertions(+), 17 deletions(-) diff --git a/htdocs/compta/bank/various_payment/card.php b/htdocs/compta/bank/various_payment/card.php index 72226f18cd6..027294663f1 100644 --- a/htdocs/compta/bank/various_payment/card.php +++ b/htdocs/compta/bank/various_payment/card.php @@ -17,7 +17,7 @@ */ /** - * \file htdocs/compta/bank/various_expenses/card.php + * \file htdocs/compta/bank/various_payment/card.php * \ingroup bank * \brief Page of various expenses */ diff --git a/htdocs/core/boxes/box_birthdays_members.php b/htdocs/core/boxes/box_birthdays_members.php index 1addf1c4827..e48271c4d84 100644 --- a/htdocs/core/boxes/box_birthdays_members.php +++ b/htdocs/core/boxes/box_birthdays_members.php @@ -2,7 +2,7 @@ /* Copyright (C) 2003-2007 Rodolphe Quiedeville * Copyright (C) 2004-2010 Laurent Destailleur * Copyright (C) 2005-2009 Regis Houssin - * Copyright (C) 2015 Frederic France + * Copyright (C) 2015-2019 Frederic France * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -19,7 +19,7 @@ */ /** - * \file htdocs/core/boxes/box_adherent_birthdays.php + * \file htdocs/core/boxes/box_birthdays_members.php * \ingroup member * \brief Box for member birthdays */ diff --git a/htdocs/core/boxes/box_last_ticket.php b/htdocs/core/boxes/box_last_ticket.php index 0ac4557431b..252141db9eb 100644 --- a/htdocs/core/boxes/box_last_ticket.php +++ b/htdocs/core/boxes/box_last_ticket.php @@ -19,7 +19,7 @@ */ /** - * \file core/boxes/box_ticket_latest.php + * \file htdocs/core/boxes/box_last_ticket.php * \ingroup ticket * \brief This box shows latest created tickets */ diff --git a/htdocs/core/boxes/box_project.php b/htdocs/core/boxes/box_project.php index edd6c89054d..68095eaec31 100644 --- a/htdocs/core/boxes/box_project.php +++ b/htdocs/core/boxes/box_project.php @@ -19,7 +19,7 @@ */ /** - * \file htdocs/core/boxes/box_activite.php + * \file htdocs/core/boxes/box_project.php * \ingroup projet * \brief Module to show Projet activity of the current Year */ diff --git a/htdocs/core/class/fileupload.class.php b/htdocs/core/class/fileupload.class.php index a4be0739aa5..beb887d8b76 100644 --- a/htdocs/core/class/fileupload.class.php +++ b/htdocs/core/class/fileupload.class.php @@ -17,7 +17,7 @@ */ /** - * \file htdocs/core/ajax/fileupload.class.php + * \file htdocs/core/class/fileupload.class.php * \brief File to return Ajax response on file upload */ diff --git a/htdocs/core/class/workboardresponse.class.php b/htdocs/core/class/workboardresponse.class.php index 12174916422..e2d9cc2c0d7 100644 --- a/htdocs/core/class/workboardresponse.class.php +++ b/htdocs/core/class/workboardresponse.class.php @@ -18,7 +18,7 @@ */ /** - * \file htdocs/core/class/WorkboardResponse.class.php + * \file htdocs/core/class/workboardresponse.class.php * \brief Class that represents response of load_board functions */ diff --git a/htdocs/product/class/product.class.php b/htdocs/product/class/product.class.php index 88a0fc30488..e32f0c32f8f 100644 --- a/htdocs/product/class/product.class.php +++ b/htdocs/product/class/product.class.php @@ -252,7 +252,7 @@ class Product extends CommonObject /** * Customs code * - * @var + * @var string */ public $customcode; diff --git a/htdocs/zapier/class/api_zapier.class.php b/htdocs/zapier/class/api_zapier.class.php index c4fb81065d5..638b02c0c58 100644 --- a/htdocs/zapier/class/api_zapier.class.php +++ b/htdocs/zapier/class/api_zapier.class.php @@ -263,15 +263,15 @@ class ZapierApi extends DolibarrApi ); } - /** - * Update hook - * - * @param int $id Id of hook to update - * @param array $request_data Datas - * @return int - * - * @url PUT /hooks/{id} - */ + // /** + // * Update hook + // * + // * @param int $id Id of hook to update + // * @param array $request_data Datas + // * @return int + // * + // * @url PUT /hooks/{id} + // */ /*public function put($id, $request_data = null) { if (! DolibarrApiAccess::$user->rights->zapier->write) {