]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
regulator: core: Fix incorrectly formatted kerneldoc "Return" sections
authorChen-Yu Tsai <wenst@chromium.org>
Thu, 29 Aug 2024 08:51:23 +0000 (16:51 +0800)
committerMark Brown <broonie@kernel.org>
Thu, 29 Aug 2024 13:20:24 +0000 (14:20 +0100)
commitf746af13dd115ae3e0ec9d762baa170184401d41
tree05db93d271305b00329b1f9bcb6c700d4f4d1d3e
parent753b9d86adb9d2c5882ac8ee0c3816aa48697eaa
regulator: core: Fix incorrectly formatted kerneldoc "Return" sections

kernel-doc complains about missing "Return" section for many documented
functions in the regulator core. Many of them actually have descriptions
about the return values, just not in the format kernel-doc wants.

Convert these to use the proper "Return:" section header. The existing
descriptions have been reworded and moved around to fit the grammar and
formatting.

In a few cases where the functions don't call even more functions
and the error numbers are known, those are documented in detail.

Signed-off-by: Chen-Yu Tsai <wenst@chromium.org>
Reported-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Link: https://patch.msgid.link/20240829085131.1361701-4-wenst@chromium.org
Signed-off-by: Mark Brown <broonie@kernel.org>
drivers/regulator/core.c