Skip to content

Commit 3a3d5fe

Browse files
authored
Small IRQ doxygen tweaks (#824)
1 parent 5e22c09 commit 3a3d5fe

File tree

1 file changed

+4
-4
lines changed
  • src/rp2_common/hardware_irq/include/hardware

1 file changed

+4
-4
lines changed

src/rp2_common/hardware_irq/include/hardware/irq.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ static inline void check_irq_param(__unused uint num) {
126126
/*! \brief Set specified interrupt's priority
127127
* \ingroup hardware_irq
128128
*
129-
* \param num Interrupt number
129+
* \param num Interrupt number \ref interrupt_nums
130130
* \param hardware_priority Priority to set.
131131
* Numerically-lower values indicate a higher priority. Hardware priorities
132132
* range from 0 (highest priority) to 255 (lowest priority) though only the
@@ -147,7 +147,7 @@ void irq_set_priority(uint num, uint8_t hardware_priority);
147147
* initialized to PICO_DEFAULT_IRQ_PRIORITY by the SDK runtime at startup.
148148
* PICO_DEFAULT_IRQ_PRIORITY defaults to 0x80
149149
*
150-
* \param num Interrupt number
150+
* \param num Interrupt number \ref interrupt_nums
151151
* \return the IRQ priority
152152
*/
153153
uint irq_get_priority(uint num);
@@ -171,7 +171,7 @@ bool irq_is_enabled(uint num);
171171
/*! \brief Enable/disable multiple interrupts on the executing core
172172
* \ingroup hardware_irq
173173
*
174-
* \param mask 32-bit mask with one bits set for the interrupts to enable/disable
174+
* \param mask 32-bit mask with one bits set for the interrupts to enable/disable \ref interrupt_nums
175175
* \param enabled true to enable the interrupts, false to disable them.
176176
*/
177177
void irq_set_mask_enabled(uint32_t mask, bool enabled);
@@ -216,7 +216,7 @@ irq_handler_t irq_get_exclusive_handler(uint num);
216216
* the (total across all IRQs on both cores) maximum (configurable via PICO_MAX_SHARED_IRQ_HANDLERS) number of shared handlers
217217
* would be exceeded.
218218
*
219-
* \param num Interrupt number
219+
* \param num Interrupt number \ref interrupt_nums
220220
* \param handler The handler to set. See \ref irq_handler_t
221221
* \param order_priority The order priority controls the order that handlers for the same IRQ number on the core are called.
222222
* The shared irq handlers for an interrupt are all called when an IRQ fires, however the order of the calls is based

0 commit comments

Comments
 (0)