summaryrefslogtreecommitdiff
path: root/libcr_ipc/include
diff options
context:
space:
mode:
Diffstat (limited to 'libcr_ipc/include')
-rw-r--r--libcr_ipc/include/libcr_ipc/chan.h6
-rw-r--r--libcr_ipc/include/libcr_ipc/sema.h6
2 files changed, 6 insertions, 6 deletions
diff --git a/libcr_ipc/include/libcr_ipc/chan.h b/libcr_ipc/include/libcr_ipc/chan.h
index 6e9865a..551684d 100644
--- a/libcr_ipc/include/libcr_ipc/chan.h
+++ b/libcr_ipc/include/libcr_ipc/chan.h
@@ -1,4 +1,4 @@
-/* libcr_ipc/chan.h - Simple channel system for libcr
+/* libcr_ipc/chan.h - Simple channels for libcr
*
* Copyright (C) 2024 Luke T. Shumaker <lukeshu@lukeshu.com>
* SPDX-Licence-Identifier: AGPL-3.0-or-later
@@ -11,7 +11,7 @@
#include <libcr/coroutine.h>
/**
- * cr_chan_t(val_t) is a simple unbuffered (Go-like) channel that
+ * A cr_chan_t(val_t) is a simple unbuffered (Go-like) channel that
* transports values of type `val_t`.
*
* None of the methods have `_from_intrhandler` variants because
@@ -33,7 +33,7 @@
* having these functions take `void*`. */
/**
- * ch_chan_send(*ch, val) sends `val` over `ch`.
+ * ch_chan_send(ch, val) sends `val` over `ch`.
*
* @runs_in coroutine
* @cr_pauses maybe
diff --git a/libcr_ipc/include/libcr_ipc/sema.h b/libcr_ipc/include/libcr_ipc/sema.h
index 81787d6..410c092 100644
--- a/libcr_ipc/include/libcr_ipc/sema.h
+++ b/libcr_ipc/include/libcr_ipc/sema.h
@@ -83,7 +83,7 @@ static inline bool _cr_sema_drain(cr_sema_t *sema, bool in_intrhandler) {
/**
* Increment the semaphore,
*
- * @run_in coroutine
+ * @runs_in coroutine
* @cr_pauses never
* @cr_yields never
*/
@@ -96,7 +96,7 @@ static inline void cr_sema_signal(cr_sema_t *sema) {
/**
* Like cr_sema_signal(), but safe to call from an interrupt handler.
*
- * @run_in intrhandler
+ * @runs_in intrhandler
*/
static inline void cr_sema_signal_from_intrhandler(cr_sema_t *sema) {
sema->cnt++;
@@ -107,7 +107,7 @@ static inline void cr_sema_signal_from_intrhandler(cr_sema_t *sema) {
/**
* Wait until the semaphore is >0, then decrement it.
*
- * @run_in coroutine
+ * @runs_in coroutine
* @cr_pauses maybe
* @cr_yields maybe
*/