diff options
| author | David Robillard <d@drobilla.net> | 2022-11-17 12:07:21 -0500 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2022-11-17 12:09:45 -0500 |
| commit | 68d02a48ea89d45f16f7901bf46849ea923841c0 (patch) | |
| tree | dcab96020bd40c7e4d663d96701bba470abb08ce /include/zix/ring.h | |
| parent | e0cb455ac899829cf9fe41bbd6015f5567a9bbcb (diff) | |
| download | zix-68d02a48ea89d45f16f7901bf46849ea923841c0.tar.gz zix-68d02a48ea89d45f16f7901bf46849ea923841c0.tar.bz2 zix-68d02a48ea89d45f16f7901bf46849ea923841c0.zip | |
Improve documentation
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. */ |