Skip to content

Commit 6d0e083

Browse files
committed
Fix slist API documentation
1 parent 8d40bfc commit 6d0e083

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ and this project adheres to [0-based versioning](https://0ver.org/).
3131
- Check for NULL event pointer in `log_queue()` in DPP example application.
3232
- Fix documentation of `prio` parameter of `am_pal_task_create()` API.
3333
- Use proper type casting in `AM_ALIGNOF_PTR()` and `AM_ALIGN_SIZE()` implementations.
34+
- Fix `slist` API documentation.
3435

3536
## v0.12.0 - 23-July-2025
3637

libs/slist/slist.h

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,8 @@ extern "C" {
109109
/**
110110
* Construct singly linked list.
111111
*
112+
* Must be called before calling any other singly linked list API functions.
113+
*
112114
* @param list the list
113115
*/
114116
void am_slist_ctor(struct am_slist *list);
@@ -136,6 +138,8 @@ bool am_slist_item_is_linked(const struct am_slist_item *item);
136138
/**
137139
* Construct list item.
138140
*
141+
* Initializes the list item as not belonging to any list.
142+
*
139143
* @param item the list item to construct.
140144
*/
141145
void am_slist_item_ctor(struct am_slist_item *item);
@@ -191,6 +195,7 @@ typedef bool (*am_slist_item_found_fn)(
191195
* @param list the list
192196
* @param is_found the predicate callback
193197
* @param context the context, which is provided verbatim to predicate
198+
* callback
194199
*
195200
* @return the item, found by the predicate callback function or
196201
* NULL, if nothing was found.
@@ -206,7 +211,7 @@ struct am_slist_item *am_slist_find(
206211
*
207212
* @param list the list
208213
*
209-
* @return the item at the front of the list or NULL, if list is empty
214+
* @return the item at the front of the list or NULL, if the list is empty
210215
*/
211216
struct am_slist_item *am_slist_peek_front(const struct am_slist *list);
212217

@@ -265,7 +270,7 @@ bool am_slist_owns(
265270
* Get next list item.
266271
*
267272
* @param list the list
268-
* @param item the item to be checked
273+
* @param item return next list item after this one
269274
*
270275
* @return the next list item or NULL
271276
*/

0 commit comments

Comments
 (0)