Add a better description for this macro.
Signed-off-by: Simon Glass <s...@chromium.org>
---
include/alist.h | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
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))
--
2.34.1
