Skip to content

Commit

Permalink
doxygen todo
Browse files Browse the repository at this point in the history
  • Loading branch information
frederic34 committed Dec 11, 2019
1 parent 6f4e2e7 commit 307bad1
Show file tree
Hide file tree
Showing 17 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion htdocs/adherents/subscription.php
Expand Up @@ -898,7 +898,7 @@
'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);
}
Expand Down
2 changes: 1 addition & 1 deletion htdocs/admin/ticket.php
Expand Up @@ -432,7 +432,7 @@
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>';
Expand Down
2 changes: 1 addition & 1 deletion htdocs/categories/class/categorie.class.php
Expand Up @@ -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',
Expand Down
2 changes: 1 addition & 1 deletion htdocs/comm/action/class/actioncomm.class.php
Expand Up @@ -1112,7 +1112,7 @@ public function update($user, $notrigger = 0)

/**
* 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
Expand Down
2 changes: 1 addition & 1 deletion htdocs/compta/cashcontrol/cashcontrol_card.php
Expand Up @@ -248,7 +248,7 @@
$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)
{
Expand Down
2 changes: 1 addition & 1 deletion htdocs/compta/prelevement/class/rejetprelevement.class.php
Expand Up @@ -280,7 +280,7 @@ private function _send_email($fac)
*
* @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)
{
Expand Down
2 changes: 1 addition & 1 deletion htdocs/compta/resultat/result.php
Expand Up @@ -420,7 +420,7 @@
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;
Expand Down
2 changes: 1 addition & 1 deletion htdocs/compta/stats/index.php
Expand Up @@ -194,7 +194,7 @@
$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";
Expand Down
2 changes: 1 addition & 1 deletion htdocs/core/actions_massactions.inc.php
Expand Up @@ -1280,7 +1280,7 @@
}

// 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();
Expand Down
4 changes: 2 additions & 2 deletions htdocs/core/actions_sendmails.inc.php
Expand Up @@ -431,7 +431,7 @@
$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;
Expand All @@ -444,7 +444,7 @@
$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;
Expand Down
6 changes: 3 additions & 3 deletions htdocs/core/class/commonobject.class.php
Expand Up @@ -2598,7 +2598,7 @@ public function line_down($rowid, $fk_parent_line = true)
*/
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;
Expand Down Expand Up @@ -4883,7 +4883,7 @@ protected function commonGenerateDocument($modelspath, $modele, $outputlangs, $h

/**
* 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
Expand Down Expand Up @@ -6607,7 +6607,7 @@ public function showOptionals($extrafields, $mode = 'view', $params = null, $key
// 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;
Expand Down
2 changes: 1 addition & 1 deletion htdocs/core/class/html.formfile.class.php
Expand Up @@ -971,7 +971,7 @@ public function getDocumentsLink($modulepart, $modulesubdir, $filedir, $filter =
}

// 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), '/');
Expand Down
2 changes: 1 addition & 1 deletion htdocs/core/class/notify.class.php
Expand Up @@ -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',
Expand Down
Expand Up @@ -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',
Expand Down
4 changes: 2 additions & 2 deletions htdocs/expensereport/class/expensereport.class.php
Expand Up @@ -2712,8 +2712,8 @@ public function getExpAmount(ExpenseReportRule $rule, $fk_user, $mode = 'day')
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');

Expand Down
2 changes: 1 addition & 1 deletion htdocs/stripe/payment.php
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion htdocs/user/class/user.class.php
Expand Up @@ -1971,7 +1971,7 @@ public function setPassword($user, $password = '', $changelater = 0, $notrigger
*
* @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)
Expand Down

0 comments on commit 307bad1

Please sign in to comment.