lkml.org 
[lkml]   [2020]   [Jul]   [18]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH 04/30] iio: adc: ad7298: Demote obvious misuse of kerneldoc to standard comment blocks
On Thu, 16 Jul 2020 14:59:02 +0100
Lee Jones <lee.jones@linaro.org> wrote:

> No attempt has been made to document either of the demoted functions here.
>
> Fixes the following W=1 kernel build warning(s):
>
> drivers/iio/adc/ad7298.c:106: warning: Function parameter or member 'indio_dev' not described in 'ad7298_update_scan_mode'
> drivers/iio/adc/ad7298.c:106: warning: Function parameter or member 'active_scan_mask' not described in 'ad7298_update_scan_mode'
> drivers/iio/adc/ad7298.c:154: warning: Function parameter or member 'irq' not described in 'ad7298_trigger_handler'
> drivers/iio/adc/ad7298.c:154: warning: Function parameter or member 'p' not described in 'ad7298_trigger_handler'
>
> Cc: Michael Hennerich <Michael.Hennerich@analog.com>
> Signed-off-by: Lee Jones <lee.jones@linaro.org>
As both are static, no particular reason they should have kernel-doc comments
so agreed we are better fixing this one by demoting rather than adding
the missing stuff.
Applied.

> ---
> drivers/iio/adc/ad7298.c | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/iio/adc/ad7298.c b/drivers/iio/adc/ad7298.c
> index dc8d8c5f6ad36..006b6f63cf4e8 100644
> --- a/drivers/iio/adc/ad7298.c
> +++ b/drivers/iio/adc/ad7298.c
> @@ -98,9 +98,9 @@ static const struct iio_chan_spec ad7298_channels[] = {
> IIO_CHAN_SOFT_TIMESTAMP(8),
> };
>
> -/**
> +/*
> * ad7298_update_scan_mode() setup the spi transfer buffer for the new scan mask
> - **/
> + */
> static int ad7298_update_scan_mode(struct iio_dev *indio_dev,
> const unsigned long *active_scan_mask)
> {
> @@ -144,12 +144,12 @@ static int ad7298_update_scan_mode(struct iio_dev *indio_dev,
> return 0;
> }
>
> -/**
> +/*
> * ad7298_trigger_handler() bh of trigger launched polling to ring buffer
> *
> * Currently there is no option in this driver to disable the saving of
> * timestamps within the ring.
> - **/
> + */
> static irqreturn_t ad7298_trigger_handler(int irq, void *p)
> {
> struct iio_poll_func *pf = p;

\
 
 \ /
  Last update: 2020-07-18 16:30    [W:2.117 / U:0.020 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site