From 55c8aad164da140485f8cb146765523b3c7811ce Mon Sep 17 00:00:00 2001 From: Simon Glass Date: Sat, 19 Oct 2024 09:21:42 -0600 Subject: [PATCH] alist: Add a comment for alist_init_struct() Comment this macro so that it is clear how to use it. Signed-off-by: Simon Glass --- include/alist.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/include/alist.h b/include/alist.h index 0343946bc4..a727f1c7df 100644 --- a/include/alist.h +++ b/include/alist.h @@ -198,6 +198,12 @@ bool alist_expand_by(struct alist *lst, uint inc_by); */ bool alist_init(struct alist *lst, uint obj_size, uint alloc_size); +/** + * alist_init_struct() - Typed version of alist_init() + * + * Use as: + * alist_init(&lst, struct my_struct); + */ #define alist_init_struct(_lst, _struct) \ alist_init(_lst, sizeof(_struct), 0) -- 2.39.5