doxygen todo

This commit is contained in:
Frédéric FRANCE 2019-12-11 19:11:13 +01:00
parent 6f4e2e7e61
commit 307bad1d2a
No known key found for this signature in database
GPG Key ID: 06809324E4B2ABC1
17 changed files with 21 additions and 21 deletions

View File

@ -898,7 +898,7 @@ if ($rowid > 0)
'moreattr' => 'maxlength="128"', '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); print $form->formconfirm($_SERVER["PHP_SELF"]."?rowid=".$object->id, $langs->trans("CreateDolibarrThirdParty"), $langs->trans("ConfirmCreateThirdParty"), "confirm_create_thirdparty", $formquestion, 1);
} }

View File

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

View File

@ -98,7 +98,7 @@ class Categorie extends CommonObject
/** /**
* @var array Foreign keys mapping from type string * @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( protected $MAP_CAT_FK = array(
'product' => 'product', 'product' => 'product',

View File

@ -1112,7 +1112,7 @@ class ActionComm extends CommonObject
/** /**
* Load all objects with filters. * 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 DoliDb $db Database handler
* @param int $socid Filter by thirdparty * @param int $socid Filter by thirdparty

View File

@ -248,7 +248,7 @@ if ($action == "create" || $action == "start")
$vartouse = 'CASHDESK_ID_BANKACCOUNT_CASH'.$terminaltouse; $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) $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. // Hook to get the good bank id according to posmodule and posnumber.
// @TODO add hook here // @todo add hook here
if ($bankid > 0) if ($bankid > 0)
{ {

View File

@ -280,7 +280,7 @@ class RejetPrelevement
* *
* @param int $amounts If you want to get the amount of the order for each invoice * @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 * @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) private function getListInvoices($amounts = 0)
{ {

View File

@ -420,7 +420,7 @@ elseif ($modecompta=="BOOKKEEPING")
foreach ($cpts as $i => $cpt) // Loop on each account. foreach ($cpts as $i => $cpt) // Loop on each account.
{ {
// We make 1 loop for each account because we may want detail per 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 // Each month
$resultN = 0; $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 = "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.= " FROM ".MAIN_DB_PREFIX."accounting_bookkeeping as b, ".MAIN_DB_PREFIX."accounting_journal as aj";
$sql.= " WHERE b.entity = ".$conf->entity; $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"; $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 // Generate document foreach object according to model linked to object
// @TODO : propose model selection // @todo : propose model selection
if (!$error && $massaction == 'generate_doc' && $permissiontoread) if (!$error && $massaction == 'generate_doc' && $permissiontoread)
{ {
$db->begin(); $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->socid = $sendtosocid; // To link to a company
$object->sendtoid = $sendtoid; // To link to contact addresses. This is an array. $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->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->actionmsg2 = $actionmsg2; // Short text ($langs->transnoentities('MailSentBy')...);
$object->trackid = $trackid; $object->trackid = $trackid;
@ -444,7 +444,7 @@ if (($action == 'send' || $action == 'relance') && ! $_POST['addfile'] && ! $_PO
$object->sendtouserid = $sendtouserid; $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_from = $from;
$object->email_subject = $subject; $object->email_subject = $subject;
$object->email_to = $sendto; $object->email_to = $sendto;

View File

@ -2598,7 +2598,7 @@ abstract class CommonObject
*/ */
public function updateRangOfLine($rowid, $rang) 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'; 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; $sql = 'UPDATE '.MAIN_DB_PREFIX.$this->table_element_line.' SET '.$fieldposition.' = '.$rang;
@ -4883,7 +4883,7 @@ abstract class CommonObject
/** /**
* Build thumb * 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. * @param string $file Path file in UTF8 to original file to create thumbs from.
* @return void * @return void
@ -6607,7 +6607,7 @@ abstract class CommonObject
// Show only the key field in params // Show only the key field in params
if (is_array($params) && array_key_exists('onlykey', $params) && $key != $params['onlykey']) continue; 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; $enabled = 1;
$visibility = 1; $visibility = 1;

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) // 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)) if (!empty($conf->global->MAIN_SHOW_ALL_FILES_ON_DOCUMENT_TOOLTIP))
{ {
$filterforfilesearch = preg_quote(basename($modulesubdir), '/'); $filterforfilesearch = preg_quote(basename($modulesubdir), '/');

View File

@ -65,7 +65,7 @@ class Notify
// Les codes actions sont definis dans la table llx_notify_def // Les codes actions sont definis dans la table llx_notify_def
// codes actions supported are // 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( public $arrayofnotifsupported = array(
'BILL_VALIDATE', 'BILL_VALIDATE',
'BILL_PAYED', 'BILL_PAYED',

View File

@ -44,7 +44,7 @@ class InterfaceNotification extends DolibarrTriggers
*/ */
public $picto = 'email'; public $picto = 'email';
// @TODO Defined also into notify.class.php) // @todo Defined also into notify.class.php)
public $listofmanagedevents=array( public $listofmanagedevents=array(
'BILL_VALIDATE', 'BILL_VALIDATE',
'BILL_PAYED', 'BILL_PAYED',

View File

@ -2712,8 +2712,8 @@ class ExpenseReportLine
if (!empty($this->id)) $sql.= ' AND d.rowid <> '.$this->id; if (!empty($this->id)) $sql.= ' AND d.rowid <> '.$this->id;
$sql .= ' AND d.fk_c_type_fees = '.$rule->fk_c_type_fees; $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').'\''; 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 == '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 == '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'); dol_syslog('ExpenseReportLine::getExpAmount');

View File

@ -28,7 +28,7 @@
/** /**
* \file htdocs/stripe/payment.php * \file htdocs/stripe/payment.php
* \ingroup stripe * \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 // Load Dolibarr environment

View File

@ -1971,7 +1971,7 @@ class User extends CommonObject
* *
* @param User $user Object user that send email * @param User $user Object user that send email
* @param string $password New password * @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 * @return int < 0 si erreur, > 0 si ok
*/ */
public function send_password($user, $password = '', $changelater = 0) public function send_password($user, $password = '', $changelater = 0)