libs/rt-thread-official
libs
/
rt-thread-official
mirror of https://github.com/RT-Thread/rt-thread.git
4
0
Fork 0
Code Issues Releases Wiki Activity

Update annotation

This commit is contained in:
ousugo 2021-12-01 14:43:53 +08:00
parent 2ef0d40aff
commit b329611e35
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
components/drivers/src/dataqueue.c
View File

@ -84,6 +84,7 @@ RTM_EXPORT(rt_data_queue_init);
* @param timeout is the waiting time. * @param timeout is the waiting time.
* *
* @return Return the operation status. When the return value is RT_EOK, the operation is successful. * @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, rt_err_t rt_data_queue_push(struct rt_data_queue *queue,
const void *data_ptr, const void *data_ptr,
@ -200,6 +201,7 @@ RTM_EXPORT(rt_data_queue_push);
* @param timeout is the waiting time. * @param timeout is the waiting time.
* *
* @return Return the operation status. When the return value is RT_EOK, the operation is successful. * @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, rt_err_t rt_data_queue_pop(struct rt_data_queue *queue,
const void** data_ptr, 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. * @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. * @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, rt_err_t rt_data_queue_peek(struct rt_data_queue *queue,
const void** data_ptr, const void** data_ptr,