RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

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

Browse Source 
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
This commit is contained in:
Joe Kroesche 2017-10-28 13:44:02 -05:00
parent 2e0917cd81
commit 5b6d311830
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
core/include/ringbuffer.h
View File

@ -1,18 +1,24 @@
/**
* 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.
* @}
*/