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

Andy Shevchenko
2024-06-05T20:02:40Z

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