Commit 38c9a740 authored by Marcel Krüger's avatar Marcel Krüger Committed by Fabio Baltieri
Browse files

kernel.h: Fix k_msgq_get retval doxygen 

Added a hint about -ENOMSG being returned when the
queue is purged.

Signed-off-by: default avatarMarcel Krüger <marcel.krueger@ithinx.io>
parent b6aed5c5

include/zephyr/kernel.h

+1 −1
Changes for include/zephyr/kernel.h: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -4684,7 +4684,7 @@ __syscall int k_msgq_put(struct k_msgq *msgq, const void *data, k_timeout_t time 
 *                K_FOREVER.

 *

 * @retval 0 Message received.

 * @retval -ENOMSG Returned without waiting.

 * @retval -ENOMSG Returned without waiting or queue purged.

 * @retval -EAGAIN Waiting period timed out.

 */

__syscall int k_msgq_get(struct k_msgq *msgq, void *data, k_timeout_t timeout);

CRA Git | Maintained and supported by SUSTech CRA and CCSE