Update doc

This commit is contained in:
Henrik Stickann
2022-05-10 02:12:44 +02:00
parent e2854fceee
commit b73e03fddf
8 changed files with 120 additions and 17 deletions

View File

@@ -14,11 +14,26 @@ namespace sta
class FifoBuffer
{
public:
/**
* @brief FIFO size type.
*/
using size_type = Size;
/**
* @brief Max number of bytes in FIFO.
*/
static constexpr size_type MAX_SIZE = N;
public:
/**
* @brief Construct empty FIFO buffer.
*/
FifoBuffer();
/**
* @brief Construct FIFO buffer with initial data.
*
* @param buffer Source buffer
* @param size Buffer size
*/
FifoBuffer(const uint8_t * buffer, Size size);
/**