Skip to content
Snippets Groups Projects
Commit 5b6d3118 authored by Joe Kroesche's avatar Joe Kroesche
Browse files

core/include/ringbuffer.h: add doc ref to tsrb.

Updated file comment header to comply with coding standard;
added brief module description and reference to tsrb to guide reader
who might be looking for thread-safe implementation
parent 2e0917cd
No related branches found
No related tags found
No related merge requests found
/**
* Ringbuffer header
*
/*
* Copyright (C) 2013 Freie Universität Berlin
* Copyright (C) 2013 INRIA
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*
*/
/**
* @ingroup core_util
* @{
* @file
* @author Kaspar Schleiser <kaspar@schleiser.de>
* @author René Kijewski <rene.kijewski@fu-berlin.de>
*
* @brief A utility for storing and retrieving byte data using a ring buffer.
*
* @details The ringbuffer is useful for buffering data in the same
* thread context but it is not thread-safe. For a thread-safe ring
* buffer, see @ref sys_tsrb in the System library.
* @}
*/
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment