diff options
Diffstat (limited to 'pw_sync/public/pw_sync/binary_semaphore.h')
| -rw-r--r-- | pw_sync/public/pw_sync/binary_semaphore.h | 14 |
1 files changed, 6 insertions, 8 deletions
diff --git a/pw_sync/public/pw_sync/binary_semaphore.h b/pw_sync/public/pw_sync/binary_semaphore.h index 8ae96a0ac..c3e025dea 100644 --- a/pw_sync/public/pw_sync/binary_semaphore.h +++ b/pw_sync/public/pw_sync/binary_semaphore.h @@ -25,13 +25,11 @@ namespace pw::sync { -/// @class BinarySemaphore -/// -/// BinarySemaphore is a specialization of CountingSemaphore with an arbitrary -/// token limit of 1. Note that that max() is >= 1, meaning it may be -/// released up to max() times but only acquired once for those N releases. -/// Implementations of BinarySemaphore are typically more efficient than the -/// default implementation of CountingSemaphore. The entire API is thread safe +/// `BinarySemaphore` is a specialization of `CountingSemaphore` with an +/// arbitrary token limit of 1. Note that that max() is >= 1, meaning it may be +/// released up to `max()` times but only acquired once for those `N` releases. +/// Implementations of `BinarySemaphore` are typically more efficient than the +/// default implementation of `CountingSemaphore`. The entire API is thread safe /// but only a subset is IRQ safe. /// /// WARNING: In order to support global statically constructed BinarySemaphores, @@ -39,7 +37,7 @@ namespace pw::sync { /// environment is done prior to the creation and/or initialization of the /// native synchronization primitives (e.g. kernel initialization). /// -/// The BinarySemaphore is initialized to being empty or having no tokens. +/// The `BinarySemaphore` is initialized to being empty or having no tokens. class BinarySemaphore { public: using native_handle_type = backend::NativeBinarySemaphoreHandle; |