| Message ID | 20240827095550.675018-7-wenst@chromium.org (mailing list archive) |
|---|---|
| State | Superseded, archived |
| Headers | show |
| Series | regulator: kerneldoc section fixes | expand |
On Tue, Aug 27, 2024 at 05:55:46PM +0800, Chen-Yu Tsai wrote: > 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. ... > + * Return: pointer to populated &struct fixed_voltage_config or %NULL if Seems to me this should be "pointer to the" > + * memory alloc fails.
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,
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@chromium.org> --- drivers/regulator/fixed.c | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)