]> git.dujemihanovic.xyz Git - u-boot.git/commitdiff
linker_lists: document ll_entry_ref parameters
authorHeinrich Schuchardt <xypron.glpk@gmx.de>
Sun, 28 Mar 2021 08:53:18 +0000 (10:53 +0200)
committerHeinrich Schuchardt <xypron.glpk@gmx.de>
Sat, 10 Apr 2021 10:00:24 +0000 (12:00 +0200)
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>
include/linker_lists.h

index 81a280a8841eb6e771eafe8ac0784048355e247a..2fea54c8343d2f6555ba8fca1ba46b13c6692e27 100644 (file)
  *
  * 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)