Skip to content

Commit

Permalink
doc: kernel/arch: fix some wrong doxygen references
Browse files Browse the repository at this point in the history
Remove non-existing references and document parameters.

Signed-off-by: Anas Nashif <[email protected]>
  • Loading branch information
nashif committed Sep 17, 2024
1 parent ac808d1 commit ca09a4b
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
12 changes: 8 additions & 4 deletions include/zephyr/arch/arc/v2/arcv2_irq_unit.h
Original file line number Diff line number Diff line change
Expand Up @@ -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 <irq> to trigger an interrupt based on the level or the
* edge of the signal. Valid values for <trigger> 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)
Expand All @@ -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 <irq> trigger type.
* Valid values for <trigger> 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
*/
Expand Down
2 changes: 1 addition & 1 deletion kernel/sched.c
Original file line number Diff line number Diff line change
Expand Up @@ -905,7 +905,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.
*
Expand Down

0 comments on commit ca09a4b

Please sign in to comment.