Skip to content

Commit ea52dff

Browse files
author
zigam
committed
- updated readme
1 parent cdf500e commit ea52dff

1 file changed

Lines changed: 3 additions & 6 deletions

File tree

README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,6 @@ typedef float float32_t;
4848

4949
## API
5050

51-
API of ring buffer constist of three blocks, those are: initialization, add element to buffer and get element from buffer. Note that getting element from buffer intakes intiger parameter as support normal and invers access. Invers access meas that get function will return time related element from ring buffer. This feature is specially handy when comes to digital filter calculations.
52-
53-
#### List of API functions:
5451
- ring_buffer_status_t **ring_buffer_init** (p_ring_buffer_t * p_ring_buffer, const uint32_t size, const ring_buffer_attr_t * const p_attr);
5552
- ring_buffer_status_t **ring_buffer_is_init** (p_ring_buffer_t buf_inst, bool * const p_is_init);
5653

@@ -136,14 +133,14 @@ for ( i = 0; i < taken; i++ )
136133
{
137134
ring_buffer_get( my_ring_buffer, &item );
138135

139-
// So something with "item" value here...
136+
// Do something with "item" value here...
140137
}
141138

142139
// OR equivalent
143140

144141
while( eRING_BUFFER_EMPTY != ring_buffer_get( my_ring_buffer, &item ))
145142
{
146-
// So something with "item" value here...
143+
// Do something with "item" value here...
147144
}
148145

149146

@@ -181,7 +178,7 @@ for ( i = 0; i < filter_inst -> order; i++ )
181178
182179
```C
183180
// My ring buffer is initialized for byte items
184-
uint8_t item;
181+
uint8_t item = 42;
185182
186183
// Add value to buffer
187184
ring_buffer_add( my_ringbuffer, &item );

0 commit comments

Comments
 (0)