Commit 14c1ff25 authored by Benjamin Cabé's avatar Benjamin Cabé Committed by Johan Hedberg
Browse files

doc: ring_buffer: Properly expose Doxygen doc for ring_buf struct

Move the ring_buf struct in the Doxygen group containing all other APIs.

Signed-off-by: default avatarBenjamin Cabé <benjamin@zephyrproject.org>
parent bbf46b96
Loading
Loading
Loading
Loading
+10 −10
Changes for include/zephyr/sys/ring_buffer.h: 10 added lines, 10 removed lines.
Original line number Diff line number Diff line
@@ -25,6 +25,16 @@ extern "C" {
	"Size too big"
/** @endcond */

/**
 * @file
 * @defgroup ring_buffer_apis Ring Buffer APIs
 * @ingroup datastructure_apis
 *
 * @brief Simple ring buffer implementation.
 *
 * @{
 */

/**
 * @brief A structure to represent a ring buffer
 */
@@ -41,16 +51,6 @@ struct ring_buf {
	/** @endcond */
};

/**
 * @file
 * @defgroup ring_buffer_apis Ring Buffer APIs
 * @ingroup datastructure_apis
 *
 * @brief Simple ring buffer implementation.
 *
 * @{
 */

/**
 * @brief Function to force ring_buf internal states to given value
 *