Skip to content

Commit

Permalink
doc: doxygen: move mpsc and spsc under data structure API group
Browse files Browse the repository at this point in the history
Both MPSC and SPSC should be under data structure API group
instead of kernel API group. So move them, and fix some doxygen
cosmetic grouping issues for SPSC.

Signed-off-by: Daniel Leung <[email protected]>
  • Loading branch information
dcpleung authored and nashif committed Nov 15, 2023
1 parent 1554205 commit 483dd8a
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
2 changes: 1 addition & 1 deletion include/zephyr/sys/mpsc_pbuf.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ extern "C" {
/**
* @brief Multi producer, single consumer packet buffer API
* @defgroup mpsc_buf MPSC (Multi producer, single consumer) packet buffer API
* @ingroup kernel_apis
* @ingroup datastructure_apis
* @{
*/

Expand Down
5 changes: 3 additions & 2 deletions include/zephyr/sys/spsc_pbuf.h
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,12 @@ extern "C" {

/**
* @brief Single producer, single consumer packet buffer API
* @ingroup kernel_apis
* @defgroup spsc_buf SPSC (Single producer, single consumer) packet buffer API
* @ingroup datastructure_apis
* @{
*/

/**@defgroup SPSC_PBUF_FLAGS MPSC packet buffer flags
/**@defgroup SPSC_PBUF_FLAGS SPSC packet buffer flags
* @{
*/

Expand Down

0 comments on commit 483dd8a

Please sign in to comment.