Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

staging: iio: frequency: ad9834: Provide missing description for 'devid'

Also demote kernel-doc abuses

Fixes the following W=1 kernel build warning(s):

drivers/staging/iio/frequency/ad9834.c:87: warning: Function parameter or member 'devid' not described in 'ad9834_state'
drivers/staging/iio/frequency/ad9834.c:93: warning: cannot understand function prototype: 'enum ad9834_supported_device_ids '
drivers/staging/iio/frequency/ad9834.c:320: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

Cc: Lars-Peter Clausen <lars@metafoo.de>
Cc: Michael Hennerich <Michael.Hennerich@analog.com>
Cc: Jonathan Cameron <jic23@kernel.org>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: linux-iio@vger.kernel.org
Cc: linux-staging@lists.linux.dev
Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20210414181129.1628598-22-lee.jones@linaro.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Lee Jones and committed by
Greg Kroah-Hartman
d57d7ac5 0b18e5fe

+3 -2
+3 -2
drivers/staging/iio/frequency/ad9834.c
··· 58 58 * @spi: spi_device 59 59 * @mclk: external master clock 60 60 * @control: cached control word 61 + * @devid: device id 61 62 * @xfer: default spi transfer 62 63 * @msg: default spi message 63 64 * @freq_xfer: tuning word spi transfer ··· 87 86 __be16 freq_data[2]; 88 87 }; 89 88 90 - /** 89 + /* 91 90 * ad9834_supported_device_ids: 92 91 */ 93 92 ··· 317 316 static IIO_DEVICE_ATTR(out_altvoltage0_out1_wavetype_available, 0444, 318 317 ad9834_show_out1_wavetype_available, NULL, 0); 319 318 320 - /** 319 + /* 321 320 * see dds.h for further information 322 321 */ 323 322