Skip to content

Commit b329611

Browse files
committed
Update annotation
1 parent 2ef0d40 commit b329611

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

components/drivers/src/dataqueue.c

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ RTM_EXPORT(rt_data_queue_init);
8484
* @param timeout is the waiting time.
8585
*
8686
* @return Return the operation status. When the return value is RT_EOK, the operation is successful.
87+
* When the return value is RT_ETIMEOUT, it means the specified time out.
8788
*/
8889
rt_err_t rt_data_queue_push(struct rt_data_queue *queue,
8990
const void *data_ptr,
@@ -200,6 +201,7 @@ RTM_EXPORT(rt_data_queue_push);
200201
* @param timeout is the waiting time.
201202
*
202203
* @return Return the operation status. When the return value is RT_EOK, the operation is successful.
204+
* When the return value is RT_ETIMEOUT, it means the specified time out.
203205
*/
204206
rt_err_t rt_data_queue_pop(struct rt_data_queue *queue,
205207
const void** data_ptr,
@@ -322,6 +324,7 @@ RTM_EXPORT(rt_data_queue_pop);
322324
* @param size is the size in bytes of the data to be fetched.
323325
*
324326
* @return Return the operation status. When the return value is RT_EOK, the operation is successful.
327+
* When the return value is -RT_EEMPTY, it means the data queue is empty.
325328
*/
326329
rt_err_t rt_data_queue_peek(struct rt_data_queue *queue,
327330
const void** data_ptr,

0 commit comments

Comments
 (0)