mirror of
https://github.com/RT-Thread/rt-thread.git
synced 2025-12-26 01:07:21 +00:00
[ringbuffer] 添加 ringbuffer 的接口注释
This commit is contained in:
@@ -5,6 +5,7 @@
|
||||
*
|
||||
* Change Logs:
|
||||
* Date Author Notes
|
||||
* 2021-08-14 Jackistang add commets for function inferface.
|
||||
*/
|
||||
#ifndef RINGBUFFER_H__
|
||||
#define RINGBUFFER_H__
|
||||
@@ -80,6 +81,13 @@ struct rt_ringbuffer* rt_ringbuffer_create(rt_uint16_t length);
|
||||
void rt_ringbuffer_destroy(struct rt_ringbuffer *rb);
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @brief Get buffer size of the ringbuffer object.
|
||||
*
|
||||
* @param rb A pointer to the ringbuffer object.
|
||||
*
|
||||
* @return Buffer size.
|
||||
*/
|
||||
rt_inline rt_uint16_t rt_ringbuffer_get_size(struct rt_ringbuffer *rb)
|
||||
{
|
||||
RT_ASSERT(rb != RT_NULL);
|
||||
|
||||
@@ -6,6 +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()
|
||||
*/
|
||||
#ifndef WORKQUEUE_H__
|
||||
#define WORKQUEUE_H__
|
||||
|
||||
Reference in New Issue
Block a user