Linux-ARM-Kernel Archive on lore.kernel.org
 help / color / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: jic23@kernel.org, knaack.h@gmx.de, lars@metafoo.de, pmeerw@pmeerw.net
Cc: linux-iio@vger.kernel.org, Adriana Reus <adriana.reus@intel.com>,
	Lee Jones <lee.jones@linaro.org>,
	linux-kernel@vger.kernel.org,
	linux-arm-kernel@lists.infradead.org
Subject: [PATCH 10/30] iio: light: us5182d: Fix formatting in kerneldoc function block
Date: Fri, 17 Jul 2020 17:55:18 +0100
Message-ID: <20200717165538.3275050-11-lee.jones@linaro.org> (raw)
In-Reply-To: <20200717165538.3275050-1-lee.jones@linaro.org>

Kerneldoc expects attributes/parameters to be in '@*.: ' format.

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

 drivers/iio/light/us5182d.c:457: warning: Function parameter or member 'data' not described in 'us5182d_update_dark_th'
 drivers/iio/light/us5182d.c:457: warning: Function parameter or member 'index' not described in 'us5182d_update_dark_th'
 drivers/iio/light/us5182d.c:479: warning: Function parameter or member 'data' not described in 'us5182d_apply_scale'
 drivers/iio/light/us5182d.c:479: warning: Function parameter or member 'index' not described in 'us5182d_apply_scale'

Cc: Adriana Reus <adriana.reus@intel.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/iio/light/us5182d.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/drivers/iio/light/us5182d.c b/drivers/iio/light/us5182d.c
index b995f21a33479..24843597beba5 100644
--- a/drivers/iio/light/us5182d.c
+++ b/drivers/iio/light/us5182d.c
@@ -446,8 +446,8 @@ static int us5182d_read_raw(struct iio_dev *indio_dev,
 
 /**
  * us5182d_update_dark_th - update Darh_Th registers
- * @data	us5182d_data structure
- * @index	index in us5182d_dark_ths array to use for the updated value
+ * @data:	us5182d_data structure
+ * @index:	index in us5182d_dark_ths array to use for the updated value
  *
  * Function needs to be called with a lock held because it needs two i2c write
  * byte operations as these registers (0x27 0x28) don't work in word mode
@@ -469,8 +469,8 @@ static int us5182d_update_dark_th(struct us5182d_data *data, int index)
 
 /**
  * us5182d_apply_scale - update the ALS scale
- * @data	us5182d_data structure
- * @index	index in us5182d_scales array to use for the updated value
+ * @data:	us5182d_data structure
+ * @index:	index in us5182d_scales array to use for the updated value
  *
  * Function needs to be called with a lock held as we're having more than one
  * i2c operation.
-- 
2.25.1


_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

  parent reply index

Thread overview: 65+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-17 16:55 [PATCH 00/30] Second batch of W=1 fixes for IIO Lee Jones
2020-07-17 16:55 ` [PATCH 01/30] iio: adc: ti_am335x_adc: Remove a couple of unused 'read' variables Lee Jones
2020-07-18 15:30   ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 02/30] iio: adc: twl4030-madc: Remove set but unused variables 'len' Lee Jones
2020-07-18 15:32   ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 03/30] iio: adc: twl4030-madc: Fix misnamed struct attribute Lee Jones
2020-07-18 15:33   ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 04/30] iio: magnetometer: hmc5843: 'hmc5843_pm_ops' is unused in 1 of 3 files including hmc5843_core.h Lee Jones
2020-07-18 15:34   ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 05/30] iio: adc: twl6030-gpadc: Fix some misdocumentation and formatting issues Lee Jones
2020-07-18 15:38   ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 06/30] iio: dac: ltc2632: Fix formatting in kerneldoc struct header Lee Jones
2020-07-18 15:39   ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 07/30] iio: light: si1145: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-18 15:40   ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 08/30] iio: resolver: ad2s1200: Change ordering of compiler attribute macro Lee Jones
2020-07-18 15:41   ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 09/30] iio: temperature: mlx90632: Function parameter descriptions must match exactly Lee Jones
2020-07-17 19:48   ` Crt Mori
2020-07-18 15:42     ` Jonathan Cameron
2020-07-17 16:55 ` Lee Jones [this message]
2020-07-18 15:44   ` [PATCH 10/30] iio: light: us5182d: Fix formatting in kerneldoc function block Jonathan Cameron
2020-07-17 16:55 ` [PATCH 11/30] iio: adc: ad799x: Demote seemingly unintentional kerneldoc header Lee Jones
2020-07-18 15:47   ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 12/30] iio: dac: ad5504: Fix formatting errors and demote non-compliant kerneldoc Lee Jones
2020-07-18 15:48   ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 13/30] iio: adc: at91_adc: Fix 'bad line' warning Lee Jones
2020-07-18 15:48   ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 14/30] iio: adc: at91-sama5d2_adc: Struct kerneldoc titles need to start with 'struct ' Lee Jones
2020-07-18 15:49   ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 15/30] iio: adc: cpcap-adc: Demote seemingly unintentional kerneldoc header Lee Jones
2020-07-18 15:50   ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 16/30] iio: accel: sca3000: Fix 2 misspellings and demote nonconforming kerneldocs Lee Jones
2020-07-18 15:51   ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 17/30] iio: gyro: adxrs450: Change ordering of compiler attribute macro Lee Jones
2020-07-18 15:52   ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 18/30] iio: gyro: fxas21002c: Move 'fxas21002c_reg_fields' to the only file its used Lee Jones
2020-07-18 15:54   ` Jonathan Cameron
2020-07-22 20:20   ` Rui Miguel Silva
2020-07-17 16:55 ` [PATCH 19/30] iio: imu: st_lsm6dsx: st_lsm6dsx: Reorder 'inline' declaration Lee Jones
2020-07-18 15:54   ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 20/30] iio: adc: max1363: Fix kerneldoc attribute formatting for 'lock' Lee Jones
2020-07-18 15:56   ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 21/30] iio: adc: max9611: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-18 15:59   ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 22/30] iio: adc: mcp320x: Change ordering of compiler attribute macro Lee Jones
2020-07-18 16:00   ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 23/30] iio: adc: palmas_gpadc: Demote non-conforming kerneldoc header Lee Jones
2020-07-18 16:01   ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 24/30] iio: imu: inv_mpu6050: inv_mpu_core: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-18 16:02   ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 25/30] iio: imu: inv_mpu6050: inv_mpu_ring: Demote seemingly unintentional kerneldoc header Lee Jones
2020-07-18 16:03   ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 26/30] iio: adc: qcom-pm8xxx-xoadc: Demote standard comment block and supply missing description Lee Jones
2020-07-17 20:15   ` Bjorn Andersson
2020-07-18 16:06     ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 27/30] iio: magnetometer: ak8974: Add description for ak8974's 'scan' attribute Lee Jones
2020-07-18 16:08   ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 28/30] iio: imu: st_lsm6dsx: st_lsm6dsx_shub: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-18 16:13   ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 29/30] iio: imu: st_lsm6dsx: st_lsm6dsx: Mark 'st_lsm6dsx_accel_ext_info' as __maybe_unused Lee Jones
2020-07-18 16:14   ` Jonathan Cameron
2020-07-17 16:55 ` [PATCH 30/30] iio: adc: rockchip_saradc: Demote Demote seemingly unintentional kerneldoc header Lee Jones
2020-07-17 19:10   ` Heiko Stübner
2020-07-18 16:15     ` Jonathan Cameron

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=20200717165538.3275050-11-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=adriana.reus@intel.com \
    --cc=jic23@kernel.org \
    --cc=knaack.h@gmx.de \
    --cc=lars@metafoo.de \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=pmeerw@pmeerw.net \
    /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

Linux-ARM-Kernel Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-arm-kernel/0 linux-arm-kernel/git/0.git
	git clone --mirror https://lore.kernel.org/linux-arm-kernel/1 linux-arm-kernel/git/1.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-arm-kernel linux-arm-kernel/ https://lore.kernel.org/linux-arm-kernel \
		linux-arm-kernel@lists.infradead.org
	public-inbox-index linux-arm-kernel

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.infradead.lists.linux-arm-kernel


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git