[PATCH V2 09/19] irqchip: crossbar: fix kerneldoc warning
From: Jason Cooper <hidden>
Date: 2014-06-12 13:14:49
Also in:
linux-devicetree, linux-omap, lkml
On Thu, Jun 12, 2014 at 05:23:17PM +0530, Sricharan R wrote:
From: Nishanth Menon <nm@ti.com> kernel doc style is wrong in code. fix it to squelch kerneldoc warnings:
I would re-word the above to mention that we need to add missing properties for kerneldoc (@write, @safemap), and we're doing some cleanup of harmless warnings while we are here.
quoted hunk ↗ jump to hunk
Warning(drivers/irqchip/irq-crossbar.c:27): missing initial short description on line: * struct crossbar_device: crossbar device description Info(drivers/irqchip/irq-crossbar.c:27): Scanning doc for struct Warning(drivers/irqchip/irq-crossbar.c:39): No description found for parameter 'write' Warning(drivers/irqchip/irq-crossbar.c:42): missing initial short description on line: * struct crossbar_data: Platform specific data Info(drivers/irqchip/irq-crossbar.c:42): Scanning doc for struct Warning(drivers/irqchip/irq-crossbar.c:50): No description found for parameter 'safe_map' 4 warnings Signed-off-by: Nishanth Menon <nm@ti.com> --- drivers/irqchip/irq-crossbar.c | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-)diff --git a/drivers/irqchip/irq-crossbar.c b/drivers/irqchip/irq-crossbar.c index 58790d4..7d4db07 100644 --- a/drivers/irqchip/irq-crossbar.c +++ b/drivers/irqchip/irq-crossbar.c@@ -23,11 +23,13 @@ #define IRQ_SKIP -3 #define GIC_IRQ_START 32 -/* +/** + * struct crossbar_device - crossbar device descriptio
s/descriptio/description/ thx, Jason.
quoted hunk ↗ jump to hunk
* @int_max: maximum number of supported interrupts * @irq_map: array of interrupts to crossbar number mapping * @crossbar_base: crossbar base address * @register_offsets: offsets for each irq number + * @write: register write function pointer */ struct crossbar_device { uint int_max;@@ -39,9 +41,10 @@ struct crossbar_device { }; /** - * struct crossbar_data: Platform specific data + * struct crossbar_data - Platform specific data * @irqs_unused: array of irqs that cannot be used because of hw erratas * @size: size of the irqs_unused array + * @safe_map: safe value to write to crossbar register */ struct crossbar_data { const uint *irqs_unused;-- 1.7.9.5