Re: [PATCH] iio: imu: adis: fix all kernel-doc warnings in header file
From: Jonathan Cameron
Date: Mon Oct 27 2025 - 10:48:28 EST
On Mon, 27 Oct 2025 13:03:54 +0000
Nuno Sá <noname.nuno@xxxxxxxxx> wrote:
> On Sat, 2025-10-25 at 19:47 -0700, Randy Dunlap wrote:
> > Correct and add to adis.h to resolve all kernel-doc warnings:
> >
> > - add a missing struct member description
> > - change one non-kernel-doc comment to use /* instead of /**
> > - correct function parameter @value to @val (7 locations)
> > - add function return value comments (13 locations)
> >
> > Warning: include/linux/iio/imu/adis.h:97 struct member 'has_fifo'
> > not described in 'adis_data'
> > Warning: include/linux/iio/imu/adis.h:139 Incorrect use of kernel-doc
> > format: * The state_lock is meant to be used during operations that
> > require
> > Warning: include/linux/iio/imu/adis.h:158 struct member '"__adis_"'
> > not described in 'adis'
> > Warning: include/linux/iio/imu/adis.h:264 function parameter 'val'
> > not described in 'adis_write_reg'
> > Warning: include/linux/iio/imu/adis.h:371 No description found for
> > return value of 'adis_update_bits_base'
> >
> > Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> > ---
>
> Thanks!
>
> Reviewed-by: Nuno Sá <nuno.sa@xxxxxxxxxx>
Applied. Thanks.
Jonathan