From: Jonathan Cameron <jic23@kernel.org>
To: David Lechner <dlechner@baylibre.com>
Cc: linux-iio@vger.kernel.org,
Michael Hennerich <Michael.Hennerich@analog.com>,
Angelo Dureghello <adureghello@baylibre.com>,
Alexandru Ardelean <aardelean@baylibre.com>,
Beniamin Bia <beniamin.bia@analog.com>,
Stefan Popa <stefan.popa@analog.com>,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH 06/11] iio: adc: ad7606: fix kernel-doc comments
Date: Sat, 15 Mar 2025 18:55:08 +0000 [thread overview]
Message-ID: <20250315185508.526cbec6@jic23-huawei> (raw)
In-Reply-To: <20250312-iio-adc-ad7606-improvements-v1-6-d1ec04847aea@baylibre.com>
On Wed, 12 Mar 2025 20:15:44 -0500
David Lechner <dlechner@baylibre.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@baylibre.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 ;)
next prev parent reply other threads:[~2025-03-15 18:55 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-03-13 1:15 [PATCH 00/11] iio: adc: ad7606: improvements and ad7606c parallel interface support David Lechner
2025-03-13 1:15 ` [PATCH 01/11] iio: adc: ad7606_spi: check error in ad7606B_sw_mode_config() David Lechner
2025-03-15 18:48 ` Jonathan Cameron
2025-03-13 1:15 ` [PATCH 02/11] iio: adc: ad7606: check for NULL before calling sw_mode_config() David Lechner
2025-03-13 1:15 ` [PATCH 03/11] iio: adc: ad7606: fix scales_available attributes David Lechner
2025-03-13 1:15 ` [PATCH 04/11] iio: adc: ad7606: add missing max sample rates David Lechner
2025-03-13 1:15 ` [PATCH 05/11] iio: adc: ad7606: use devm_mutex_init() David Lechner
2025-03-15 18:52 ` Jonathan Cameron
2025-03-13 1:15 ` [PATCH 06/11] iio: adc: ad7606: fix kernel-doc comments David Lechner
2025-03-15 18:55 ` Jonathan Cameron [this message]
2025-03-13 1:15 ` [PATCH 07/11] iio: adc: ad7606: use kernel identifier name style David Lechner
2025-03-13 1:15 ` [PATCH 08/11] iio: adc: ad7606: don't use address field David Lechner
2025-03-13 1:15 ` [PATCH 09/11] iio: adc: ad7606: drop ch param from ad7606_scale_setup_cb_t David Lechner
2025-03-13 1:15 ` [PATCH 10/11] iio: adc: ad7606: dynamically allocate channel info David Lechner
2025-03-15 19:02 ` Jonathan Cameron
2025-03-13 1:15 ` [PATCH 11/11] iio: adc: ad7606_par: add ad7606c chips David Lechner
2025-03-13 21:11 ` [PATCH 00/11] iio: adc: ad7606: improvements and ad7606c parallel interface support Nuno Sá
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250315185508.526cbec6@jic23-huawei \
--to=jic23@kernel.org \
--cc=Michael.Hennerich@analog.com \
--cc=aardelean@baylibre.com \
--cc=adureghello@baylibre.com \
--cc=beniamin.bia@analog.com \
--cc=dlechner@baylibre.com \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=stefan.popa@analog.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox