Clarify coral::ring_buffer doc comment that it is a ring buffer

This commit is contained in:
kayomn 2023-02-20 22:03:37 +00:00
parent cea0a4e0ed
commit 0b8167ce1d
1 changed files with 2 additions and 2 deletions

View File

@ -641,8 +641,8 @@ export namespace coral {
}
/**
* Multiplexing byte buffer of `capacity` size that may be used for memory-backed I/O
* operations and lightweight data construction.
* Multiplexing byte-based ring buffer of `capacity` size that may be used for memory-backed
* I/O operations and lightweight data construction.
*/
template<usize capacity> struct ring_buffer : public writer, public reader {
ring_buffer(coral::u8 fill_value) : data{fill_value} {}