diff options
Diffstat (limited to 'include/zix/ring.h')
| -rw-r--r-- | include/zix/ring.h | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/include/zix/ring.h b/include/zix/ring.h index 04c3bda..181a7a3 100644 --- a/include/zix/ring.h +++ b/include/zix/ring.h @@ -34,8 +34,9 @@ typedef struct ZixRingImpl ZixRing; /** Create a new ring. - @param allocator Allocator for the ring. - @param size Size in bytes (note this may be rounded up). + @param allocator Allocator for the ring object and its array. + + @param size Size of the ring in bytes (note this may be rounded up). At most `size` - 1 bytes may be stored in the ring at once. */ |