kernel.h: Fix k_msgq_get retval doxygen

Marcel Krüger · fabiobaltieri · commit 38c9a7409973 · 2024-10-06T20:51:18.000+01:00
Added a hint about -ENOMSG being returned when the
queue is purged.

Signed-off-by: Marcel Krüger &lt;marcel.krueger@ithinx.io&gt;
diff --git a/include/zephyr/kernel.h b/include/zephyr/kernel.h
@@ -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);

Original file line number	Diff line number	Diff line change
`@@ -4684,7 +4684,7 @@ __syscall int k_msgq_put(struct k_msgq msgq, const void data, k_timeout_t time`
`4684`	`4684`	`* K_FOREVER.`
`4685`	`4685`	`*`
`4686`	`4686`	`* @retval 0 Message received.`
`4687`		`- * @retval -ENOMSG Returned without waiting.`
	`4687`	`+ * @retval -ENOMSG Returned without waiting or queue purged.`
`4688`	`4688`	`* @retval -EAGAIN Waiting period timed out.`
`4689`	`4689`	`*/`
`4690`	`4690`	`__syscall int k_msgq_get(struct k_msgq msgq, void data, k_timeout_t timeout);`