Skip to content

Commit

Permalink
core/include/ringbuffer.h: add doc ref to tsrb.
Browse files Browse the repository at this point in the history
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
  • Loading branch information
kroesche committed Oct 29, 2017
1 parent 2e0917c commit 5b6d311
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions core/include/ringbuffer.h
Original file line number Diff line number Diff line change
@@ -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.
* @}
*/

Expand Down

0 comments on commit 5b6d311

Please sign in to comment.