Merge pull request #12692 from frederic34/doxygen_todo

doxygen todo
This commit is contained in:
Laurent Destailleur 2019-12-14 13:46:47 +01:00 committed by GitHub
commit 95bd95cbef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
49 changed files with 137 additions and 144 deletions

View File

@ -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 (<FILE>)
{
$insidedquote=0;
}
}
}
}
}
$ignore="";

View File

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

View File

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

View File

@ -87,12 +87,9 @@ if ($action != 'create' && $action != 'edit')
}
/* ************************************************************************** */
/* */
/* Creation of an optional field
/* */
/* ************************************************************************** */
/*
* Creation of an optional field
*/
if ($action == 'create')
{
print '<br><div id="newattrib"></div>';
@ -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 "<br>";

View File

@ -587,8 +587,8 @@ if (!empty($conf->global->SHIPPABLE_ORDER_ICON_IN_LIST)) {
print '</a></td>';
print '</tr>';
/* 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)
{

View File

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

View File

@ -432,7 +432,7 @@ print '</td>';
print '</tr>';
*/
// @TODO Use module notification instead...
// @todo Use module notification instead...
// Email de réception des notifications
print '<tr class="oddeven"><td>'.$langs->trans("TicketEmailNotificationTo").'</td>';

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -2,7 +2,7 @@
/* Copyright (C) 2003-2007 Rodolphe Quiedeville <rodolphe@quiedeville.org>
* Copyright (C) 2004-2010 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2005-2009 Regis Houssin <regis.houssin@inodbox.com>
* Copyright (C) 2015 Frederic France <frederic.france@free.fr>
* Copyright (C) 2015-2019 Frederic France <frederic.france@netlogic.fr>
*
* 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
*/

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -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.
*/

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -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.
*/

View File

@ -252,7 +252,7 @@ class Product extends CommonObject
/**
* Customs code
*
* @var
* @var string
*/
public $customcode;

View File

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

View File

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

View File

@ -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/group_extrafields.php
* \ingroup user
* \brief Page to setup extra fields of users
*/
require '../../main.inc.php';

View File

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

View File

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

View File

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