From: Heinrich Schuchardt <xypron.glpk@gmx.de>
Date: Sun, 28 Mar 2021 08:53:18 +0000 (+0200)
Subject: linker_lists: document ll_entry_ref parameters
X-Git-Url: http://git.dujemihanovic.xyz/?a=commitdiff_plain;h=f44c214541b8e194e284a4d08e95f3ed09a0b262;p=u-boot.git

linker_lists: document ll_entry_ref parameters

Avoid 'make htmldocs' build warnings:

    ./include/linker_lists.h:224: warning:
    Function parameter or member '_type' not described in 'll_entry_ref'
    ./include/linker_lists.h:224: warning:
    Function parameter or member '_name' not described in 'll_entry_ref'
    ./include/linker_lists.h:224: warning:
    Function parameter or member '_list' not described in 'll_entry_ref'

Fixes: 851144350b6f ("linker_lists: Allow use in data structures")
Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Reviewed-by: Simon Glass <sjg@chromium.org>
---

diff --git a/include/linker_lists.h b/include/linker_lists.h
index 81a280a884..2fea54c834 100644
--- a/include/linker_lists.h
+++ b/include/linker_lists.h
@@ -219,6 +219,10 @@
  *
  * This is like ll_entry_get(), but without the extra code, so it is suitable
  * for putting into data structures.
+ *
+ * @_type: C type of the list entry, e.g. 'struct foo'
+ * @_name: name of the entry
+ * @_list: name of the list
  */
 #define ll_entry_ref(_type, _name, _list)				\
 	((_type *)&_u_boot_list_2_##_list##_2_##_name)