From 8a7fbe39737baff1b926f952d0d21f085abc035e Mon Sep 17 00:00:00 2001 From: Christian Prochaska Date: Mon, 11 Jun 2012 16:46:30 +0200 Subject: [PATCH] Fix ring buffer interface description The maximum number of elements in the ring buffer is QUEUE_SIZE - 1. Fixes #240. --- os/include/os/ring_buffer.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/os/include/os/ring_buffer.h b/os/include/os/ring_buffer.h index 204770c5e..50ebb3037 100644 --- a/os/include/os/ring_buffer.h +++ b/os/include/os/ring_buffer.h @@ -22,7 +22,8 @@ * Ring buffer template * * \param ET element type - * \param QUEUE_SIZE maximum number of ring-buffer elements + * \param QUEUE_SIZE number of element slots in the ring. the maximum number of + * ring-buffer elements is QUEUE_SIZE - 1 * * The ring buffer manages its elements as values. * When inserting an element, a copy of the element is