[PATCH 6/8] regulator: fixed: Fix incorrectly formatted kerneldoc "Return" section

Chen-Yu Tsai wenst at chromium.org
Tue Aug 27 02:55:46 PDT 2024


kernel-doc complains about missing "Return" section for kerneldoc of
of_get_fixed_voltage_config(). The kerneldoc has a description
about the return values, just not in the format kernel-doc wants.

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

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

diff --git a/drivers/regulator/fixed.c b/drivers/regulator/fixed.c
index cb93e5cdcfa9..1629aa525ef2 100644
--- a/drivers/regulator/fixed.c
+++ b/drivers/regulator/fixed.c
@@ -158,8 +158,10 @@ static int reg_fixed_get_irqs(struct device *dev,
  * @desc: regulator description
  *
  * Populates fixed_voltage_config structure by extracting data from device
- * tree node, returns a pointer to the populated structure of NULL if memory
- * alloc fails.
+ * tree node.
+ *
+ * Return: pointer to populated &struct fixed_voltage_config or %NULL if
+ *	   memory alloc fails.
  */
 static struct fixed_voltage_config *
 of_get_fixed_voltage_config(struct device *dev,
-- 
2.46.0.295.g3b9ea8a38a-goog




More information about the linux-arm-kernel mailing list