From 7a7c420ca8beddefa3d9d9e629194af1a884b13b Mon Sep 17 00:00:00 2001 From: Christian Taedcke Date: Tue, 30 Jun 2020 12:02:14 +0200 Subject: [PATCH] kernel: k_poll: Clarify events parameter description The functions k_work_poll_submit_to_queue(), k_work_poll_submit() and k_poll() described the parameter events as an "array of pointers to events" which is not accurate. Replaced the description with "array of events". This fixes #23775 Signed-off-by: Christian Taedcke --- include/kernel.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/include/kernel.h b/include/kernel.h index 6d2bb542e28..84e57d0a0c6 100644 --- a/include/kernel.h +++ b/include/kernel.h @@ -3473,7 +3473,7 @@ extern void k_work_poll_init(struct k_work_poll *work, * * @param work_q Address of workqueue. * @param work Address of delayed work item. - * @param events An array of pointers to events which trigger the work. + * @param events An array of events which trigger the work. * @param num_events The number of events in the array. * @param timeout Timeout after which the work will be scheduled * for execution even if not triggered. @@ -3511,7 +3511,7 @@ extern int k_work_poll_submit_to_queue(struct k_work_q *work_q, * modified until the item has been processed by the workqueue. * * @param work Address of delayed work item. - * @param events An array of pointers to events which trigger the work. + * @param events An array of events which trigger the work. * @param num_events The number of events in the array. * @param timeout Timeout after which the work will be scheduled * for execution even if not triggered. @@ -5058,7 +5058,7 @@ extern void k_poll_event_init(struct k_poll_event *event, uint32_t type, * When called from user mode, a temporary memory allocation is required from * the caller's resource pool. * - * @param events An array of pointers to events to be polled for. + * @param events An array of events to be polled for. * @param num_events The number of events in the array. * @param timeout Waiting period for an event to be ready, * or one of the special values K_NO_WAIT and K_FOREVER.