linux-kernel - Re: [PATCH 06/11] iio: adc: ad7606: fix kernel-doc comments

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20250315185508.526cbec6@jic23-huawei>
Date: Sat, 15 Mar 2025 18:55:08 +0000
From: Jonathan Cameron <jic23@...nel.org>
To: David Lechner <dlechner@...libre.com>
Cc: linux-iio@...r.kernel.org, Michael Hennerich
 <Michael.Hennerich@...log.com>, Angelo Dureghello
 <adureghello@...libre.com>, Alexandru Ardelean <aardelean@...libre.com>,
 Beniamin Bia <beniamin.bia@...log.com>, Stefan Popa
 <stefan.popa@...log.com>, linux-kernel@...r.kernel.org
Subject: Re: [PATCH 06/11] iio: adc: ad7606: fix kernel-doc comments

On Wed, 12 Mar 2025 20:15:44 -0500
David Lechner <dlechner@...libre.com> wrote:

> Fix several issues with kernel-doc comments in ad7606.h:
> * Add missing ":" to @param names.
> * Add some missing parameters.
> * Remove some non-existent parameters.
> * Fix alignment and wrapping.
> * Fix some spelling.
> 
> `./scripts/kernel-doc -v -none drivers/iio/adc/ad7606*` is happy now.
> 
> Signed-off-by: David Lechner <dlechner@...libre.com>
> ---
>  drivers/iio/adc/ad7606.h | 90 ++++++++++++++++++++++++------------------------
>  1 file changed, 45 insertions(+), 45 deletions(-)
> 
> diff --git a/drivers/iio/adc/ad7606.h b/drivers/iio/adc/ad7606.h
> index 71a30525eaab512fa811f28fa79268a1a976bc8c..3da78488c8a247dccbff930023f98717d540081a 100644
> --- a/drivers/iio/adc/ad7606.h
> +++ b/drivers/iio/adc/ad7606.h
> @@ -120,17 +120,17 @@ typedef int (*ad7606_sw_setup_cb_t)(struct iio_dev *indio_dev);
>  /**
>   * struct ad7606_chip_info - chip specific information
>   * @channels:		channel specification
> - * @max_samplerate:	maximum supported samplerate
> - * @name		device name
> + * @max_samplerate:	maximum supported sample rate
> + * @name:		device name
>   * @num_channels:	number of channels
> - * @num_adc_channels	the number of channels the ADC actually inputs.
> + * @num_adc_channels:	the number of channels the ADC actually inputs.

What does that mean?  ADCs don't input channels, they have channels which
are inputs.  Turns out I don't read the docs closely enough whilst reviewing ;)