]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
regulator: core: Add missing kerneldoc "Return" sections
authorChen-Yu Tsai <wenst@chromium.org>
Thu, 29 Aug 2024 08:51:24 +0000 (16:51 +0800)
committerMark Brown <broonie@kernel.org>
Thu, 29 Aug 2024 13:20:25 +0000 (14:20 +0100)
commit4ac204ff2d4ec360d9d2e39840ad286ddb78439f
treebc1f46cd5238ff4139a90910216b1543371d9778
parentf746af13dd115ae3e0ec9d762baa170184401d41
regulator: core: Add missing kerneldoc "Return" sections

kernel-doc complains about missing "Return" section for many documented
functions in the regulator core. Some with free-form return value
descriptions have been fixed in the previous patch. The remaining are
completely missing any mention of return values.

Add "Return" sections to these kerneldoc blocks with basic descriptions.
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-5-wenst@chromium.org
Signed-off-by: Mark Brown <broonie@kernel.org>
drivers/regulator/core.c