Added a few comments

This commit is contained in:
Steffen Gaisser 2020-09-30 16:27:18 +02:00
parent ab9858b0c7
commit fcabf93af3

View File

@ -40,11 +40,25 @@ public:
*/
ReturnValue_t pop();
/***
* Check if FIFO is empty
* @return True if empty, False if not
*/
bool empty();
/***
* Check if FIFO is Full
* @return True if full, False if not
*/
bool full();
/***
* Current used size (elements) used
* @return size_t in elements
*/
size_t size();
/***
* Get maximal capacity of fifo
* @return size_t with max capacity of this fifo
*/
size_t getMaxCapacity() const;
protected: