michaelh/zephyr
1
0
Fork 0
Code Releases Activity

lib: os: ring_buffer: Clarify macro description

Browse source 
Description was falsely static that macros statically creates
the ring buffer objects. Clarify description since variables
are not static.

Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
This commit is contained in:
Krzysztof Chruscinski 2021-08-10 10:47:09 +02:00 • committed by Christopher Friedt
commit 2aa1247998
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
include/sys/ring_buffer.h
View file

@ -64,7 +64,7 @@ struct ring_buf {
*/ */
/** /**
* @brief Statically define and initialize a high performance ring buffer. * @brief Define and initialize a high performance ring buffer.
* *
* This macro establishes a ring buffer whose size must be a power of 2; * This macro establishes a ring buffer whose size must be a power of 2;
* that is, the ring buffer contains 2^pow 32-bit words, where @a pow is * that is, the ring buffer contains 2^pow 32-bit words, where @a pow is
@ -90,7 +90,7 @@ struct ring_buf {
} }
/** /**
* @brief Statically define and initialize a standard ring buffer. * @brief Define and initialize a standard ring buffer.
* *
* This macro establishes a ring buffer of an arbitrary size. A standard * This macro establishes a ring buffer of an arbitrary size. A standard
* ring buffer uses modulo arithmetic operations to maintain itself. * ring buffer uses modulo arithmetic operations to maintain itself.
@ -113,7 +113,7 @@ struct ring_buf {
} }
/** /**
* @brief Statically define and initialize a ring buffer for byte data. * @brief Define and initialize a ring buffer for byte data.
* *
* This macro establishes a ring buffer of an arbitrary size. * This macro establishes a ring buffer of an arbitrary size.
* *