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: 851144350b ("linker_lists: Allow use in data structures")
Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Reviewed-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
Heinrich Schuchardt 2021-03-28 10:53:18 +02:00
parent b411b62fb4
commit f44c214541

View file

@ -219,6 +219,10 @@
* *
* This is like ll_entry_get(), but without the extra code, so it is suitable * This is like ll_entry_get(), but without the extra code, so it is suitable
* for putting into data structures. * 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) \ #define ll_entry_ref(_type, _name, _list) \
((_type *)&_u_boot_list_2_##_list##_2_##_name) ((_type *)&_u_boot_list_2_##_list##_2_##_name)