[PATCH 7/8] regulator: fixed-helper: Add missing "Return" kerneldoc section

Chen-Yu Tsai posted 8 patches 1 year, 3 months ago
There is a newer version of this series
[PATCH 7/8] regulator: fixed-helper: Add missing "Return" kerneldoc section
Posted by Chen-Yu Tsai 1 year, 3 months ago
kernel-doc complains about missing "Return" section for the function
regulator_register_always_on().

Add a "Return" section for it based on its behavior.

Signed-off-by: Chen-Yu Tsai <wenst@chromium.org>
---
 drivers/regulator/fixed-helper.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/drivers/regulator/fixed-helper.c b/drivers/regulator/fixed-helper.c
index 2d5a42b2b3d8..72807af63126 100644
--- a/drivers/regulator/fixed-helper.c
+++ b/drivers/regulator/fixed-helper.c
@@ -26,6 +26,8 @@ static void regulator_fixed_release(struct device *dev)
  * @supplies: consumers for this regulator
  * @num_supplies: number of consumers
  * @uv: voltage in microvolts
+ *
+ * Return: pointer to registered platform device, or %NULL if memory alloc fails.
  */
 struct platform_device *regulator_register_always_on(int id, const char *name,
 	struct regulator_consumer_supply *supplies, int num_supplies, int uv)
-- 
2.46.0.295.g3b9ea8a38a-goog
Re: [PATCH 7/8] regulator: fixed-helper: Add missing "Return" kerneldoc section
Posted by Andy Shevchenko 1 year, 3 months ago
On Tue, Aug 27, 2024 at 05:55:47PM +0800, Chen-Yu Tsai wrote:
> kernel-doc complains about missing "Return" section for the function
> regulator_register_always_on().
> 
> Add a "Return" section for it based on its behavior.

...

> + * Return: pointer to registered platform device, or %NULL if memory alloc fails.

s/alloc/allocation/


-- 
With Best Regards,
Andy Shevchenko