Re: [PATCH v2 2/2] iio: imu: inv_icm42600: fix kernel-doc Return: sections

From: Joshua Crofts

Date: Tue Oct 06 2026 - 02:46:42 EST


On Tue, 6 Oct 2026 10:24:04 +0530
Arnav Kapoor <kapoorarnav43@xxxxxxxxx> wrote:

> kernel-doc expects the return value to be described in a "Return:"
> section. inv_icm42600_buffer_update_watermark(), inv_icm42600_setup()
> and inv_icm42600_irq_init() use "Returns ..." in the body instead,
> so scripts/kernel-doc -Wall warns for each of them, e.g.:
>
> Warning: .../inv_icm42600_core.c:511 No description found for
> return value of 'inv_icm42600_setup'
>
> Convert them to "Return:" sections. In the watermark comment, move it
> after the description, so the description is not parsed as part of the
> return value section.
>
> Assisted-by: LLM
> Signed-off-by: Arnav Kapoor <kapoorarnav43@xxxxxxxxx>
> ---

Reviewed-by: Joshua Crofts <joshua.crofts1@xxxxxxxxx>

--
Kind regards,
Joshua Crofts