summaryrefslogtreecommitdiffstats
path: root/zix
diff options
context:
space:
mode:
Diffstat (limited to 'zix')
-rw-r--r--zix/ring.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/zix/ring.h b/zix/ring.h
index 67b71f5..3abb1e8 100644
--- a/zix/ring.h
+++ b/zix/ring.h
@@ -32,6 +32,8 @@ typedef struct ZixRingImpl ZixRing;
/**
Create a new ring.
@param size Size in bytes (note this may be rounded up).
+
+ At most @c size - 1 bytes may be stored in the ring at once.
*/
ZixRing*
zix_ring_new(uint32_t size);