[tip: irq/core] genirq/irqreturn: Fix kernel-doc warnings

From: tip-bot2 for Randy Dunlap
Date: Thu Nov 24 2022 - 12:04:08 EST


The following commit has been merged into the irq/core branch of tip:

Commit-ID: f2756526450d19bca28714565062a8f286c05049
Gitweb: https://git.kernel.org/tip/f2756526450d19bca28714565062a8f286c05049
Author: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
AuthorDate: Wed, 23 Nov 2022 22:30:13 -08:00
Committer: Thomas Gleixner <tglx@xxxxxxxxxxxxx>
CommitterDate: Thu, 24 Nov 2022 17:55:05 +01:00

genirq/irqreturn: Fix kernel-doc warnings

irqreturn.h:6: warning: missing initial short description on line:
* enum irqreturn
irqreturn.h:15: warning: Enum value 'IRQ_NONE' not described in enum 'irqreturn'
irqreturn.h:15: warning: Enum value 'IRQ_HANDLED' not described in enum 'irqreturn'
irqreturn.h:15: warning: Enum value 'IRQ_WAKE_THREAD' not described in enum 'irqreturn'

Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Signed-off-by: Thomas Gleixner <tglx@xxxxxxxxxxxxx>
Link: https://lore.kernel.org/r/20221124063013.28479-1-rdunlap@xxxxxxxxxxxxx

---
include/linux/irqreturn.h | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/include/linux/irqreturn.h b/include/linux/irqreturn.h
index bd4c066..d426c7a 100644
--- a/include/linux/irqreturn.h
+++ b/include/linux/irqreturn.h
@@ -3,10 +3,10 @@
#define _LINUX_IRQRETURN_H

/**
- * enum irqreturn
- * @IRQ_NONE interrupt was not from this device or was not handled
- * @IRQ_HANDLED interrupt was handled by this device
- * @IRQ_WAKE_THREAD handler requests to wake the handler thread
+ * enum irqreturn - irqreturn type values
+ * @IRQ_NONE: interrupt was not from this device or was not handled
+ * @IRQ_HANDLED: interrupt was handled by this device
+ * @IRQ_WAKE_THREAD: handler requests to wake the handler thread
*/
enum irqreturn {
IRQ_NONE = (0 << 0),