alist: Expand the comment for alist_get()

Add a better description for this macro.

Signed-off-by: Simon Glass <sjg@chromium.org>

diff --git a/include/alist.h b/include/alist.h
index a727f1c7dfa92d6465560667004298efc9091ab4..2c78ede201e2250f70ca7f9eac3e23aef73b3788 100644 (file)
--- 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))