Thread (45 messages) 45 messages, 9 authors, 2024-06-18

Re: [PATCH v2 09/19] irqdomain: Add missing parameter descriptions in docs

From: Andy Shevchenko <hidden>
Date: 2024-06-05 20:02:39
Also in: linux-arm-kernel, linux-devicetree, linux-pci, lkml

Mon, May 27, 2024 at 06:14:36PM +0200, Herve Codina kirjoitti:
During compilation, several warning of the following form were raised:
  Function parameter or struct member 'x' not described in 'yyy'

Add the missing function parameter descriptions.
...
 /**
  * irq_domain_translate_onecell() - Generic translate for direct one cell
  * bindings
+ * @d:		Interrupt domain involved in the translation
+ * @fwspec:	The firmware interrupt specifier to translate
+ * @out_hwirq:	Pointer to storage for the hardware interrupt number
+ * @out_type:	Pointer to storage for the interrupt type
(kernel-doc perhaps will complain on something missing here)
  */
 int irq_domain_translate_onecell(struct irq_domain *d,
You can go further and run

	scripts/kernel-doc -v -none -Wall ...

against this file and fix more issues, like I believe in the above excerpt.

-- 
With Best Regards,
Andy Shevchenko

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