From a4217d8abcf800a7b200d02066aade5aa8474523 Mon Sep 17 00:00:00 2001 From: Lucas Laurent Date: Thu, 17 Oct 2024 11:00:09 +0200 Subject: [PATCH] Fix misleading comments --- lib/equal/cron/Scheduler.class.php | 4 ++-- lib/equal/data/DataGenerator.class.php | 7 +++---- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/lib/equal/cron/Scheduler.class.php b/lib/equal/cron/Scheduler.class.php index 373f271b1..286e4f05e 100644 --- a/lib/equal/cron/Scheduler.class.php +++ b/lib/equal/cron/Scheduler.class.php @@ -49,7 +49,7 @@ private static function computeAvailableMemory() { * Non-recurring tasks are deleted once they've been run. * #memo - The Scheduler service always operates as root user. * - * @param int[] $tasks_ids Optional array of identifiers of specific tasks to run. + * @param int[] $tasks_ids (optional) Array of identifiers of specific tasks to run. * */ public function run($tasks_ids=[]) { @@ -165,7 +165,7 @@ public function run($tasks_ids=[]) { * @param string $name Name of the task to schedule, to ease task identification. * @param integer $moment Timestamp of the moment of the first execution. * @param string $controller Controller to invoke, with package notation. - * @param string $params JSON string holding the payload to relay to the controller. + * @param array $params The params associative array to relay to the controller. * @param boolean $recurring Flag to mark the task as recurring. */ public function schedule($name, $moment, $controller, $params, $recurring=false, $repeat_axis='day', $repeat_step='1') { diff --git a/lib/equal/data/DataGenerator.class.php b/lib/equal/data/DataGenerator.class.php index 66806137d..bf5c6b942 100644 --- a/lib/equal/data/DataGenerator.class.php +++ b/lib/equal/data/DataGenerator.class.php @@ -12,9 +12,9 @@ class DataGenerator { /** - * @param string $field Field name. - * @param string $field_descriptor Field descriptor. - * @param string $lang Lang code of the language in which the value must be generated (for multilang fields). + * @param string $field Field name. + * @param array $field_descriptor Field descriptor. + * @param string|null $lang Lang code of the language in which the value must be generated (for multilang fields). * @return array|bool|float|int|mixed|string|null */ public static function generateFromField(string $field, array $field_descriptor, string $lang = null) { @@ -882,5 +882,4 @@ public static function address($lang = null): string { self::addressCountry($lang) ); } - }