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

Herve Codina
2024-06-06T07:14:59Z

Hi Andy,

On Wed, 5 Jun 2024 23:02:30 +0300
Andy Shevchenko <andy.shevchenko@gmail.com> wrote:

> 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.
>

Yes indeed, I missed the return values.
Will be updated in the next iteration.

Best regards,
Hervé