diff options
| author | Simon Glass <sjg@chromium.org> | 2024-10-19 09:21:43 -0600 |
|---|---|---|
| committer | Tom Rini <trini@konsulko.com> | 2024-11-03 21:27:12 -0600 |
| commit | eb6e87a7ab9f93596983b57eef08509beeedf3fb (patch) | |
| tree | f3dcccb934f814b641cfd09fff3caaa8c71e0810 | |
| parent | 55c8aad164da140485f8cb146765523b3c7811ce (diff) | |
alist: Expand the comment for alist_get()
Add a better description for this macro.
Signed-off-by: Simon Glass <sjg@chromium.org>
| -rw-r--r-- | include/alist.h | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/include/alist.h b/include/alist.h index a727f1c7dfa..2c78ede201e 100644 --- a/include/alist.h +++ b/include/alist.h @@ -116,7 +116,12 @@ static inline const void *alist_getd(struct alist *lst, uint index) return lst->data + index * lst->obj_size; } -/** get an entry as a constant */ +/** + * alist_get() - get an entry as a constant + * + * Use as (to obtain element 2 of the list): + * const struct my_struct *ptr = alist_get(lst, 2, struct my_struct) + */ #define alist_get(_lst, _index, _struct) \ ((const _struct *)alist_get_ptr(_lst, _index)) |