Clarify coral::ring_buffer doc comment that it is a ring buffer
This commit is contained in:
parent
cea0a4e0ed
commit
0b8167ce1d
|
@ -641,8 +641,8 @@ export namespace coral {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Multiplexing byte buffer of `capacity` size that may be used for memory-backed I/O
|
* Multiplexing byte-based ring buffer of `capacity` size that may be used for memory-backed
|
||||||
* operations and lightweight data construction.
|
* I/O operations and lightweight data construction.
|
||||||
*/
|
*/
|
||||||
template<usize capacity> struct ring_buffer : public writer, public reader {
|
template<usize capacity> struct ring_buffer : public writer, public reader {
|
||||||
ring_buffer(coral::u8 fill_value) : data{fill_value} {}
|
ring_buffer(coral::u8 fill_value) : data{fill_value} {}
|
||||||
|
|
Loading…
Reference in New Issue