diff mbox series

iio: linux/iio.h: fix Excess kernel-doc description warning

Message ID 20231223050556.13948-1-rdunlap@infradead.org
State New
Headers
Series iio: linux/iio.h: fix Excess kernel-doc description warning |

Commit Message

Randy Dunlap Dec. 23, 2023, 5:05 a.m. UTC 
  Remove the @of_xlate: lines to prevent the kernel-doc warning:

include/linux/iio/iio.h:534: warning: Excess struct member 'of_xlate' description in 'iio_info'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Jonathan Cameron <jic23@kernel.org>
Cc: Lars-Peter Clausen <lars@metafoo.de>
Cc: linux-iio@vger.kernel.org
---
 include/linux/iio/iio.h |    6 ------
 1 file changed, 6 deletions(-)

Comments

Jonathan Cameron Dec. 26, 2023, 4:03 p.m. UTC | #1 
On Fri, 22 Dec 2023 21:05:56 -0800
Randy Dunlap <rdunlap@infradead.org> wrote:

> Remove the @of_xlate: lines to prevent the kernel-doc warning:
> 
> include/linux/iio/iio.h:534: warning: Excess struct member 'of_xlate' description in 'iio_info'
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Jonathan Cameron <jic23@kernel.org>
> Cc: Lars-Peter Clausen <lars@metafoo.de>
> Cc: linux-iio@vger.kernel.org
Applied.

Thanks,

Jonathan

> ---
>  include/linux/iio/iio.h |    6 ------
>  1 file changed, 6 deletions(-)
> 
> diff -- a/include/linux/iio/iio.h b/include/linux/iio/iio.h
> --- a/include/linux/iio/iio.h
> +++ b/include/linux/iio/iio.h
> @@ -434,13 +434,7 @@ struct iio_trigger; /* forward declarati
>   * @update_scan_mode:	function to configure device and scan buffer when
>   *			channels have changed
>   * @debugfs_reg_access:	function to read or write register value of device
> - * @of_xlate:		function pointer to obtain channel specifier index.
> - *			When #iio-cells is greater than '0', the driver could
> - *			provide a custom of_xlate function that reads the
> - *			*args* and returns the appropriate index in registered
> - *			IIO channels array.
>   * @fwnode_xlate:	fwnode based function pointer to obtain channel specifier index.
> - *			Functionally the same as @of_xlate.
>   * @hwfifo_set_watermark: function pointer to set the current hardware
>   *			fifo watermark level; see hwfifo_* entries in
>   *			Documentation/ABI/testing/sysfs-bus-iio for details on
diff mbox series

Patch

diff -- a/include/linux/iio/iio.h b/include/linux/iio/iio.h
--- a/include/linux/iio/iio.h
+++ b/include/linux/iio/iio.h
@@ -434,13 +434,7 @@  struct iio_trigger; /* forward declarati
  * @update_scan_mode:	function to configure device and scan buffer when
  *			channels have changed
  * @debugfs_reg_access:	function to read or write register value of device
- * @of_xlate:		function pointer to obtain channel specifier index.
- *			When #iio-cells is greater than '0', the driver could
- *			provide a custom of_xlate function that reads the
- *			*args* and returns the appropriate index in registered
- *			IIO channels array.
  * @fwnode_xlate:	fwnode based function pointer to obtain channel specifier index.
- *			Functionally the same as @of_xlate.
  * @hwfifo_set_watermark: function pointer to set the current hardware
  *			fifo watermark level; see hwfifo_* entries in
  *			Documentation/ABI/testing/sysfs-bus-iio for details on