summaryrefslogtreecommitdiff
path: root/components/drivers/src/dataqueue.c
diff options
context:
space:
mode:
authorousugo <[email protected]>2021-12-01 14:43:53 +0800
committerousugo <[email protected]>2021-12-01 14:43:53 +0800
commitb329611e3547d663b7914cb5966f1a849470c264 (patch)
treeecfc1a27722f6cdec82a7fb4c7b65102058a2389 /components/drivers/src/dataqueue.c
parent2ef0d40aff71d6cd8fee7af6babca689aae621a2 (diff)
Update annotation
Diffstat (limited to 'components/drivers/src/dataqueue.c')
-rw-r--r--components/drivers/src/dataqueue.c3
1 files changed, 3 insertions, 0 deletions
diff --git a/components/drivers/src/dataqueue.c b/components/drivers/src/dataqueue.c
index 1f7971a367..4e52662c44 100644
--- a/components/drivers/src/dataqueue.c
+++ b/components/drivers/src/dataqueue.c
@@ -84,6 +84,7 @@ RTM_EXPORT(rt_data_queue_init);
* @param timeout is the waiting time.
*
* @return Return the operation status. When the return value is RT_EOK, the operation is successful.
+ * When the return value is RT_ETIMEOUT, it means the specified time out.
*/
rt_err_t rt_data_queue_push(struct rt_data_queue *queue,
const void *data_ptr,
@@ -200,6 +201,7 @@ RTM_EXPORT(rt_data_queue_push);
* @param timeout is the waiting time.
*
* @return Return the operation status. When the return value is RT_EOK, the operation is successful.
+ * When the return value is RT_ETIMEOUT, it means the specified time out.
*/
rt_err_t rt_data_queue_pop(struct rt_data_queue *queue,
const void** data_ptr,
@@ -322,6 +324,7 @@ RTM_EXPORT(rt_data_queue_pop);
* @param size is the size in bytes of the data to be fetched.
*
* @return Return the operation status. When the return value is RT_EOK, the operation is successful.
+ * When the return value is -RT_EEMPTY, it means the data queue is empty.
*/
rt_err_t rt_data_queue_peek(struct rt_data_queue *queue,
const void** data_ptr,