regulator: irq_helpers: Fix regulator_irq_map_event_simple() kerneldoc
authorChen-Yu Tsai <wenst@chromium.org>
Thu, 29 Aug 2024 08:51:28 +0000 (16:51 +0800)
committerMark Brown <broonie@kernel.org>
Thu, 29 Aug 2024 13:20:29 +0000 (14:20 +0100)
commit77904c81703b7a4a929abafb837d06b49de087e6
tree56d6103f24f11c90eee4e4fb89c81e5f4a896ef4
parent4ddb16cf5390fc8546409aab3c69ffe6651b3c6b
regulator: irq_helpers: Fix regulator_irq_map_event_simple() kerneldoc

kernel-doc complains about missing "Return" section for the function
regulator_irq_map_event_simple().

Add a "Return" section for it based on its behavior. The function
actually always returns 0, but fills in fields in its @rid parameter as
needed. Expand the description of the parameter to cover this.

While at it fix a typo found in the description of the same function.

Reported-by: Matti Vaittinen <mazziesaccount@gmail.com>
Closes: https://lore.kernel.org/all/e341240e-1c1f-49a2-91cd-440888fdbda0@gmail.com/
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-9-wenst@chromium.org
Signed-off-by: Mark Brown <broonie@kernel.org>
drivers/regulator/irq_helpers.c