@@ -22,16 +22,16 @@ 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 a data queue.Calling this function will
2626 * initialize the data queue control block and set the notification callback function.
27- *
27+ *
2828 * @param queue The data queue object
2929 * @param size The maximum number of data in the data queue
3030 * @param lwm Low water mark, when the number of data in the data queue is less than this value,
3131 * will wake up the thread waiting for write data.
3232 * @param evt_notify The notification callback function
33- *
34- * @return the operation status, RT_EOK on successful,
33+ *
34+ * @return the operation status, RT_EOK on successful,
3535 * RT_ENOMEM on insufficient memory allocation failed.
3636 */
3737rt_err_t
@@ -45,7 +45,7 @@ rt_data_queue_init(struct rt_data_queue *queue,
4545
4646 queue -> evt_notify = evt_notify ;
4747
48- queue -> magic = DATAQUEUE_MAGIC ;
48+ queue -> magic = DATAQUEUE_MAGIC ;
4949 queue -> size = size ;
5050 queue -> lwm = lwm ;
5151
@@ -70,13 +70,13 @@ RTM_EXPORT(rt_data_queue_init);
7070/**
7171 * @brief This function will write data to the data queue. If the data queue is full,
7272 * the thread will suspend for the specified amount of time.
73- *
73+ *
7474 * @param queue The data queue object
7575 * @param data_ptr The buffer pointer of the data to be written
7676 * @param size The size in bytes of the data to be written
7777 * @param timeout The waiting time
78- *
79- * @return the operation status, RT_EOK on successful
78+ *
79+ * @return the operation status, RT_EOK on successful
8080 */
8181rt_err_t rt_data_queue_push (struct rt_data_queue * queue ,
8282 const void * data_ptr ,
@@ -180,15 +180,15 @@ RTM_EXPORT(rt_data_queue_push);
180180/**
181181 * @brief This function will pop data from the data queue. If the data queue is empty,
182182 * the thread will suspend for the specified amount of time.
183- *
183+ *
184184 * @attention when the number of data in the data queue is less than lwm(low water mark),
185185 * will wake up the thread waiting for write data.
186- *
186+ *
187187 * @param queue The data queue object
188188 * @param data_ptr The buffer pointer of the data to be fetched
189189 * @param size The size in bytes of the data to be fetched
190190 * @param timeout The waiting time
191- *
191+ *
192192 * @return Operation status, RT_EOK on successful, RT_ETIMEOUT on timeout.
193193 */
194194rt_err_t rt_data_queue_pop (struct rt_data_queue * queue ,
@@ -304,12 +304,12 @@ RTM_EXPORT(rt_data_queue_pop);
304304
305305/**
306306 * @brief This function will fetching but retaining data in the data queue.
307- *
307+ *
308308 * @param queue The data queue object
309309 * @param data_ptr The buffer pointer of the data to be fetched
310310 * @param size The size in bytes of the data to be fetched
311- *
312- * @return The operation status, RT_EOK on successful
311+ *
312+ * @return The operation status, RT_EOK on successful
313313 */
314314rt_err_t rt_data_queue_peek (struct rt_data_queue * queue ,
315315 const void * * data_ptr ,
@@ -339,7 +339,7 @@ RTM_EXPORT(rt_data_queue_peek);
339339/**
340340 * @brief Reset a data queue. Calling this function will wake up all threads on the data queue
341341 * that are hanging and waiting.
342- *
342+ *
343343 * @param queue The data queue object
344344 */
345345void rt_data_queue_reset (struct rt_data_queue * queue )
@@ -417,9 +417,9 @@ RTM_EXPORT(rt_data_queue_reset);
417417
418418/**
419419 * @brief Deinit a data queue.
420- *
420+ *
421421 * @param queue The data queue object
422- *
422+ *
423423 * @return operation status, RT_EOK on successful.
424424 */
425425rt_err_t rt_data_queue_deinit (struct rt_data_queue * queue )
@@ -444,9 +444,9 @@ RTM_EXPORT(rt_data_queue_deinit);
444444
445445/**
446446 * @brief This function get the number of data in the data queue.
447- *
447+ *
448448 * @param queue The data queue object
449- * @return The number of data in the data queue
449+ * @return The number of data in the data queue
450450 */
451451rt_uint16_t rt_data_queue_len (struct rt_data_queue * queue )
452452{
0 commit comments