improve comment (#658)

This commit is contained in:
Graham Sanderson 2022-04-04 16:08:12 -05:00 committed by GitHub
parent 17d53af105
commit 541f93541c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -258,6 +258,10 @@ irq_handler_t irq_get_vtable_handler(uint num);
/*! \brief Clear a specific interrupt on the executing core /*! \brief Clear a specific interrupt on the executing core
* \ingroup hardware_irq * \ingroup hardware_irq
* *
* This method is only useful for "software" IRQs that are not connected to hardware (i.e. IRQs 26-31)
* as the the NVIC always reflects the current state of the IRQ state of the hardware for hardware IRQs, and clearing
* of the IRQ state of the hardware is performed via the hardware's registers instead.
*
* \param int_num Interrupt number \ref interrupt_nums * \param int_num Interrupt number \ref interrupt_nums
*/ */
static inline void irq_clear(uint int_num) { static inline void irq_clear(uint int_num) {