Thread (23 messages) 23 messages, 4 authors, 2024-08-28
STALE683d
Revisions (2)
  1. v1 current
  2. v2 [diff vs current]

[PATCH 8/8] regulator: irq_helpers: Add missing "Return" kerneldoc section

From: Chen-Yu Tsai <wenst@chromium.org>
Date: 2024-08-27 09:56:13
Also in: lkml
Subsystem: the rest, voltage and current regulator framework, voltage and current regulator irq helpers · Maintainers: Linus Torvalds, Liam Girdwood, Mark Brown

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.

Signed-off-by: Chen-Yu Tsai <wenst@chromium.org>
---
 drivers/regulator/irq_helpers.c | 4 ++++
 1 file changed, 4 insertions(+)
diff --git a/drivers/regulator/irq_helpers.c b/drivers/regulator/irq_helpers.c
index 5ab1a0befe12..5803ef016b7d 100644
--- a/drivers/regulator/irq_helpers.c
+++ b/drivers/regulator/irq_helpers.c
@@ -414,6 +414,10 @@ EXPORT_SYMBOL_GPL(regulator_irq_helper_cancel);
  * notification helperk. Exactly one rdev and exactly one error (in
  * "common_errs"-field) can be given at IRQ helper registration for
  * regulator_irq_map_event_simple() to be viable.
+ *
+ * Return: 0
+ *
+ * Actual regulator error and notification are passed back through @rid.
  */
 int regulator_irq_map_event_simple(int irq, struct regulator_irq_data *rid,
 			    unsigned long *dev_mask)
-- 
2.46.0.295.g3b9ea8a38a-goog

Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help