From 9d8e9a34bd1a697bcdf678e510a5e66610bcd9d7 Mon Sep 17 00:00:00 2001 From: Anas Nashif Date: Fri, 13 Sep 2024 06:41:57 -0400 Subject: [PATCH] doc: kernel/arch: fix some wrong doxygen references Remove non-existing references and document parameters. (cherry picked from commit ca09a4b91c4a977d743837419f11d7c9d373364e) Original-Signed-off-by: Anas Nashif GitOrigin-RevId: ca09a4b91c4a977d743837419f11d7c9d373364e Cr-Build-Id: 8736554896755799505 Cr-Build-Url: https://cr-buildbucket.appspot.com/build/8736554896755799505 Copybot-Job-Name: zephyr-main-copybot-downstream Change-Id: I6628e895407639982adcb3d0cdc2b68d9fbfacbe Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/third_party/zephyr/+/5870360 Reviewed-by: Tristan Honscheid Tested-by: Tristan Honscheid Tested-by: ChromeOS Prod (Robot) Commit-Queue: Tristan Honscheid --- include/zephyr/arch/arc/v2/arcv2_irq_unit.h | 12 ++++++++---- kernel/sched.c | 2 +- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/include/zephyr/arch/arc/v2/arcv2_irq_unit.h b/include/zephyr/arch/arc/v2/arcv2_irq_unit.h index 18cb0fa2a47..a8f3760a21b 100644 --- a/include/zephyr/arch/arc/v2/arcv2_irq_unit.h +++ b/include/zephyr/arch/arc/v2/arcv2_irq_unit.h @@ -199,9 +199,11 @@ bool z_arc_v2_irq_unit_is_in_isr(void) /** * @brief Sets an IRQ line to level/pulse trigger * - * Sets the IRQ line to trigger an interrupt based on the level or the - * edge of the signal. Valid values for are _ARC_V2_INT_LEVEL and + * Sets the IRQ line @p irq to trigger an interrupt based on the level or the + * edge of the signal. Valid values for @p trigger are _ARC_V2_INT_LEVEL and * _ARC_V2_INT_PULSE. + * @param irq IRQ line + * @param trigger Trigger state */ static ALWAYS_INLINE void z_arc_v2_irq_unit_trigger_set(int irq, unsigned int trigger) @@ -217,8 +219,10 @@ void z_arc_v2_irq_unit_trigger_set(int irq, unsigned int trigger) /** * @brief Returns an IRQ line trigger type * - * Gets the IRQ line trigger type. - * Valid values for are _ARC_V2_INT_LEVEL and _ARC_V2_INT_PULSE. + * Gets the IRQ line @p irq trigger type. + * Valid values for @retval trigger are _ARC_V2_INT_LEVEL and _ARC_V2_INT_PULSE. + * + * @param irq IRQ line * * @return trigger state */ diff --git a/kernel/sched.c b/kernel/sched.c index 464a6db0c21..5c29c03114d 100644 --- a/kernel/sched.c +++ b/kernel/sched.c @@ -912,7 +912,7 @@ static inline void set_current(struct k_thread *new_thread) * function. * * @warning - * The @ref _current value may have changed after this call and not refer + * The _current value may have changed after this call and not refer * to the interrupted thread anymore. It might be necessary to make a local * copy before calling this function. *