]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
iio: imu: adis: fix all kernel-doc warnings in header file
authorRandy Dunlap <rdunlap@infradead.org>
Sun, 26 Oct 2025 02:47:59 +0000 (19:47 -0700)
committerJonathan Cameron <Jonathan.Cameron@huawei.com>
Sun, 9 Nov 2025 12:57:04 +0000 (12:57 +0000)
commit1d165919c8261b927f8dc8cfe61eb04342bedb7e
tree2d4039ec712976c750ae762ffef361171917e89b
parentbb578dd7a01ebbb186dd6d1c27285b29f7fdba37
iio: imu: adis: fix all kernel-doc warnings in header file

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@infradead.org>
Reviewed-by: Nuno Sá <nuno.sa@analog.com>
Reviewed-by: Andy Shevchenko <andriy.shevchenko@intel.com>
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
include/linux/iio/imu/adis.h