summaryrefslogtreecommitdiffstats
path: root/include/zix/ring.h
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2022-10-20 21:03:17 -0400
committerDavid Robillard <d@drobilla.net>2022-10-20 21:10:24 -0400
commit668ffa3febb116d20add6e9460fb1fb521a22e35 (patch)
tree888e51d4b7c853f4afe77743a2d846e6799cef5f /include/zix/ring.h
parent1a98f16aabf9e2c28f97b8ec89ae35af5a333252 (diff)
downloadzix-668ffa3febb116d20add6e9460fb1fb521a22e35.tar.gz
zix-668ffa3febb116d20add6e9460fb1fb521a22e35.tar.bz2
zix-668ffa3febb116d20add6e9460fb1fb521a22e35.zip
Fix doc comments
Diffstat (limited to 'include/zix/ring.h')
-rw-r--r--include/zix/ring.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/include/zix/ring.h b/include/zix/ring.h
index 8100d2b..6fb78ac 100644
--- a/include/zix/ring.h
+++ b/include/zix/ring.h
@@ -15,9 +15,8 @@ extern "C" {
#endif
/**
- @addtogroup zix
- @{
- @name Ring
+ @defgroup zix_ring Ring
+ @ingroup zix
@{
*/
@@ -45,6 +44,8 @@ typedef struct {
/**
Create a new ring.
+
+ @param allocator Allocator for the ring.
@param size Size in bytes (note this may be rounded up).
At most `size` - 1 bytes may be stored in the ring at once.
@@ -205,7 +206,6 @@ zix_ring_commit_write(ZixRing* ZIX_NONNULL ring,
/**
@}
- @}
*/
#ifdef __cplusplus