Skip to content

Commit 02ca44b

Browse files
committed
Fix annotation grammatical mistake
1 parent 1deaa8f commit 02ca44b

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

components/drivers/src/dataqueue.c

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ struct rt_data_item
2222
};
2323

2424
/**
25-
* @brief This function will initialize a data queue.Calling this function will
25+
* @brief This function will initialize the data queue.Calling this function will
2626
* initialize the data queue control block and set the notification callback function.
2727
*
28-
* @param queue is a pointer to a data queue object.
28+
* @param queue is a pointer to the data queue object.
2929
*
3030
* @param size is the maximum number of data in the data queue.
3131
*
3232
* @param lwm is low water mark.
33-
* When the number of data in the data queue is less than this value,will
33+
* When the number of data in the data queue is less than this value, this function will
3434
* wake up the thread waiting for write data.
3535
*
3636
* @param evt_notify is the notification callback function.
@@ -75,7 +75,7 @@ RTM_EXPORT(rt_data_queue_init);
7575
* @brief This function will write data to the data queue. If the data queue is full,
7676
* the thread will suspend for the specified amount of time.
7777
*
78-
* @param queue is a pointer to a data queue object.
78+
* @param queue is a pointer to the data queue object.
7979
* .
8080
* @param data_ptr is the buffer pointer of the data to be written.
8181
*
@@ -188,10 +188,10 @@ RTM_EXPORT(rt_data_queue_push);
188188
* @brief This function will pop data from the data queue. If the data queue is empty,the thread
189189
* will suspend for the specified amount of time.
190190
*
191-
* @note when the number of data in the data queue is less than lwm(low water mark), will
191+
* @note When the number of data in the data queue is less than lwm(low water mark), will
192192
* wake up the thread waiting for write data.
193193
*
194-
* @param queue is a pointer to a data queue object.
194+
* @param queue is a pointer to the data queue object.
195195
*
196196
* @param data_ptr is the buffer pointer of the data to be fetched.
197197
*
@@ -313,9 +313,9 @@ rt_err_t rt_data_queue_pop(struct rt_data_queue *queue,
313313
RTM_EXPORT(rt_data_queue_pop);
314314

315315
/**
316-
* @brief This function will fetching but retaining data in the data queue.
316+
* @brief This function will fetch but retaining data in the data queue.
317317
*
318-
* @param queue is a pointer to a data queue object.
318+
* @param queue is a pointer to the data queue object.
319319
*
320320
* @param data_ptr is the buffer pointer of the data to be fetched.
321321
*
@@ -349,12 +349,12 @@ rt_err_t rt_data_queue_peek(struct rt_data_queue *queue,
349349
RTM_EXPORT(rt_data_queue_peek);
350350

351351
/**
352-
* @brief This function will reset a data queue.
352+
* @brief This function will reset the data queue.
353353
*
354354
* @note Calling this function will wake up all threads on the data queue
355355
* that are hanging and waiting.
356356
*
357-
* @param queue is a pointer to a data queue object.
357+
* @param queue is a pointer to the data queue object.
358358
*/
359359
void rt_data_queue_reset(struct rt_data_queue *queue)
360360
{
@@ -430,9 +430,9 @@ void rt_data_queue_reset(struct rt_data_queue *queue)
430430
RTM_EXPORT(rt_data_queue_reset);
431431

432432
/**
433-
* @brief This function will deinit a data queue.
433+
* @brief This function will deinit the data queue.
434434
*
435-
* @param queue is a pointer to a data queue object.
435+
* @param queue is a pointer to the data queue object.
436436
*
437437
* @return Return the operation status. When the return value is RT_EOK, the operation is successful.
438438
*/
@@ -459,7 +459,7 @@ RTM_EXPORT(rt_data_queue_deinit);
459459
/**
460460
* @brief This function will get the number of data in the data queue.
461461
*
462-
* @param queue is a pointer to a data queue object.
462+
* @param queue is a pointer to the data queue object.
463463
*
464464
* @return Return the number of data in the data queue.
465465
*/

0 commit comments

Comments
 (0)