diff options
Diffstat (limited to 'pw_interrupt/public/pw_interrupt/context.h')
| -rw-r--r-- | pw_interrupt/public/pw_interrupt/context.h | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/pw_interrupt/public/pw_interrupt/context.h b/pw_interrupt/public/pw_interrupt/context.h index 6b8bd123a..477400351 100644 --- a/pw_interrupt/public/pw_interrupt/context.h +++ b/pw_interrupt/public/pw_interrupt/context.h @@ -15,8 +15,11 @@ namespace pw::interrupt { -// Returns true if currently executing within an interrupt service routine -// handling an IRQ or NMI. +/// @brief Checks if the currently executing code is within an interrupt service +/// routine handling an interrupt request (IRQ) or non-maskable interrupt (NMI). +/// +/// @returns `true` if the the currently executing code is in an interrupt +/// context. `false` if not. bool InInterruptContext(); } // namespace pw::interrupt |