Mirrors_Framework/rt-thread
1
0
Fork 0
mirror of https://github.com/RT-Thread/rt-thread.git synced 2026-09-21 10:36:04 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix comments error in ringbuffer and workqueue.

Browse Source
This commit is contained in:
Jackistang
2021-08-17 22:44:29 +08:00
parent a454422bd2
commit 6173c9d7d5
4 changed files with 53 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files
components/drivers/include/ipc/ringbuffer.h
+3 -3
View File
@@ -5,7 +5,7 @@
*
* Change Logs:
* Date Author Notes
* 2021-08-14 Jackistang add commets for function inferface.
* 2021-08-14 Jackistang add comments for function interface.
*/
#ifndef RINGBUFFER_H__
#define RINGBUFFER_H__
@@ -82,9 +82,9 @@ void rt_ringbuffer_destroy(struct rt_ringbuffer *rb);
#endif
/**
* @brief Get buffer size of the ringbuffer object.
* @brief Get buffer size of the ring buffer object.
*
* @param rb A pointer to the ringbuffer object.
* @param rb A pointer to the ring buffer object.
*
* @return Buffer size.
*/
components/drivers/include/ipc/workqueue.h
+4 -4
View File
@@ -6,7 +6,7 @@
* Change Logs:
* Date Author Notes
* 2021-08-01 Meco Man remove rt_delayed_work_init() and rt_delayed_work structure
* 2021-08-14 Jackistang add commets for rt_work_init()
* 2021-08-14 Jackistang add comments for rt_work_init()
*/
#ifndef WORKQUEUE_H__
#define WORKQUEUE_H__
@@ -69,10 +69,10 @@ rt_err_t rt_work_cancel(struct rt_work *work);
#endif /* RT_USING_SYSTEM_WORKQUEUE */
/**
* @brief Init a work item, and bind it with a callback function.
* @brief Initialize a work item, binding with a callback function.
*
* @param work A pointer to work item object.
* @param work_func A callback function will be called when this work item is being executed.
* @param work A pointer to the work item object.
* @param work_func A callback function will be called when this work item is executed.
* @param work_data A user data passed to the callback function as it's second parameter.
*/
rt_inline void rt_work_init(struct rt_work *work, void (*work_func)(struct rt_work *work, void *work_data),