summaryrefslogtreecommitdiffstats
path: root/include/zix/sem.h
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2021-07-01 00:05:22 -0400
committerDavid Robillard <d@drobilla.net>2021-07-17 19:58:17 -0400
commit4b266e2f39a8d3a49b58c861c7fd852911cf7fb0 (patch)
treedc12d618dc52b640b82e522917b238e38af033b3 /include/zix/sem.h
parent46f9327b06e866e3180c1924a0afa0afd8b0b5c5 (diff)
downloadzix-4b266e2f39a8d3a49b58c861c7fd852911cf7fb0.tar.gz
zix-4b266e2f39a8d3a49b58c861c7fd852911cf7fb0.tar.bz2
zix-4b266e2f39a8d3a49b58c861c7fd852911cf7fb0.zip
Use line comments where appropriate
Diffstat (limited to 'include/zix/sem.h')
-rw-r--r--include/zix/sem.h12
1 files changed, 5 insertions, 7 deletions
diff --git a/include/zix/sem.h b/include/zix/sem.h
index d42fd08..5b018fc 100644
--- a/include/zix/sem.h
+++ b/include/zix/sem.h
@@ -63,20 +63,17 @@ struct ZixSemImpl;
*/
typedef struct ZixSemImpl ZixSem;
-/**
- Create and initialize `sem` to `initial`.
-*/
+/// Create and initialize `sem` to `initial`
static inline ZixStatus
zix_sem_init(ZixSem* sem, unsigned initial);
-/**
- Destroy `sem`.
-*/
+/// Destroy `sem`
static inline void
zix_sem_destroy(ZixSem* sem);
/**
- Increment (and signal any waiters).
+ Increment and signal any waiters.
+
Realtime safe.
*/
static inline void
@@ -84,6 +81,7 @@ zix_sem_post(ZixSem* sem);
/**
Wait until count is > 0, then decrement.
+
Obviously not realtime safe.
*/
static inline ZixStatus