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

kernel-doc complains about missing "Return" section for many documented
functions in the regulator OF-specific code. These all 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.

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-6-wenst@chromium.org
Signed-off-by: Mark Brown <broonie@kernel.org>
drivers/regulator/of_regulator.c