Fix ring buffer interface description

The maximum number of elements in the ring buffer is QUEUE_SIZE - 1.

Fixes #240.
This commit is contained in:
Christian Prochaska 2012-06-11 16:46:30 +02:00 committed by Norman Feske
parent 54051a7bb2
commit 8a7fbe3973
1 changed files with 2 additions and 1 deletions

View File

@ -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