lmb: Improve kernel-doc comments
authorSam Protsenko <semen.protsenko@linaro.org>
Wed, 11 Dec 2024 02:25:50 +0000 (20:25 -0600)
committerTom Rini <trini@konsulko.com>
Mon, 30 Dec 2024 19:20:24 +0000 (13:20 -0600)
commit22db5b213703e7ae17b8b2496393253b3664bdd5
treed2c782caa1e6d5cab84881bb9d3cdeaea1e36177
parent85ebda86faf33edea3a2467c28b47713823c904c
lmb: Improve kernel-doc comments

Fix warnings from kernel-doc script. Improve and unify overall style of
kernel-doc comments in lmb source files. Move all kernel-doc comments
for public functions into the header, as recommended in U-Boot
documentation [1]:

    Non-trivial functions should have a comment which describes what
    they do. If it is an exported function, put the comment in the
    header file so the API is in one place. If it is a static function,
    put it in the C file.

This also takes care of existing duplication. While at it, do a bit of
cosmetic cleanups as well.

No functional change.

[1] doc/develop/codingstyle.rst

Signed-off-by: Sam Protsenko <semen.protsenko@linaro.org>
Acked-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
include/lmb.h
lib/lmb.c