修改 ringbuffer 和 workqueue 注释的语法

This commit is contained in:
Jackistang
2021-08-18 09:44:52 +08:00
parent 6173c9d7d5
commit 3de03a072e
4 changed files with 56 additions and 54 deletions

View File

@@ -82,7 +82,7 @@ void rt_ringbuffer_destroy(struct rt_ringbuffer *rb);
#endif
/**
* @brief Get buffer size of the ring buffer object.
* @brief Get the buffer size of the ring buffer object.
*
* @param rb A pointer to the ring buffer object.
*

View File

@@ -72,8 +72,8 @@ rt_err_t rt_work_cancel(struct rt_work *work);
* @brief Initialize a work item, binding with a callback function.
*
* @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.
* @param work_func A callback function that will be called when this work item is executed.
* @param work_data A user data passed to the callback function as the second parameter.
*/
rt_inline void rt_work_init(struct rt_work *work, void (*work_func)(struct rt_work *work, void *work_data),
void *work_data)