add header doc comments to non-obvious util data structures

This commit is contained in:
Ian Gulliver
2026-05-01 10:47:08 -07:00
parent 1e97058b9b
commit b565a5de4c
7 changed files with 22 additions and 0 deletions

View File

@@ -3,6 +3,9 @@
#include <cstdint>
#include <span>
// Fixed-capacity FIFO with wrap-around. push_overwrite drops the oldest entry
// when full -- used by the debug log so dlog never blocks or fails. Iteration
// walks logical positions head..tail, hiding the modular indexing.
template <typename T, uint16_t N>
struct ring_buffer {
std::array<T, N> data = {};