linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org,
	Dmitry Torokhov <dmitry.torokhov@gmail.com>,
	Dan Murphy <dmurphy@ti.com>,
	linux-input@vger.kernel.org
Subject: [PATCH 16/20] input: misc: drv260x: Fix kernel-doc formatting and remove one abuse
Date: Wed,  4 Nov 2020 16:24:23 +0000	[thread overview]
Message-ID: <20201104162427.2984742-17-lee.jones@linaro.org> (raw)
In-Reply-To: <20201104162427.2984742-1-lee.jones@linaro.org>

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

 drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'input_dev' not described in 'drv260x_data'
 drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'client' not described in 'drv260x_data'
 drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'regmap' not described in 'drv260x_data'
 drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'work' not described in 'drv260x_data'
 drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'enable_gpio' not described in 'drv260x_data'
 drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'regulator' not described in 'drv260x_data'
 drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'magnitude' not described in 'drv260x_data'
 drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'mode' not described in 'drv260x_data'
 drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'library' not described in 'drv260x_data'
 drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'rated_voltage' not described in 'drv260x_data'
 drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'overdrive_voltage' not described in 'drv260x_data'
 drivers/input/misc/drv260x.c:244: warning: Function parameter or member 'voltage' not described in 'drv260x_calculate_voltage'

Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Cc: Dan Murphy <dmurphy@ti.com>
Cc: linux-input@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/input/misc/drv260x.c | 26 +++++++++++++-------------
 1 file changed, 13 insertions(+), 13 deletions(-)

diff --git a/drivers/input/misc/drv260x.c b/drivers/input/misc/drv260x.c
index 79d7fa710a714..fabe106d499d4 100644
--- a/drivers/input/misc/drv260x.c
+++ b/drivers/input/misc/drv260x.c
@@ -167,17 +167,17 @@
 
 /**
  * struct drv260x_data -
- * @input_dev - Pointer to the input device
- * @client - Pointer to the I2C client
- * @regmap - Register map of the device
- * @work - Work item used to off load the enable/disable of the vibration
- * @enable_gpio - Pointer to the gpio used for enable/disabling
- * @regulator - Pointer to the regulator for the IC
- * @magnitude - Magnitude of the vibration event
- * @mode - The operating mode of the IC (LRA_NO_CAL, ERM or LRA)
- * @library - The vibration library to be used
- * @rated_voltage - The rated_voltage of the actuator
- * @overdriver_voltage - The over drive voltage of the actuator
+ * @input_dev: Pointer to the input device
+ * @client: Pointer to the I2C client
+ * @regmap: Register map of the device
+ * @work: Work item used to off load the enable/disable of the vibration
+ * @enable_gpio: Pointer to the gpio used for enable/disabling
+ * @regulator: Pointer to the regulator for the IC
+ * @magnitude: Magnitude of the vibration event
+ * @mode: The operating mode of the IC (LRA_NO_CAL, ERM or LRA)
+ * @library: The vibration library to be used
+ * @rated_voltage: The rated_voltage of the actuator
+ * @overdriver_voltage: The over drive voltage of the actuator
 **/
 struct drv260x_data {
 	struct input_dev *input_dev;
@@ -234,12 +234,12 @@ static const struct reg_default drv260x_reg_defs[] = {
 #define DRV260X_DEF_RATED_VOLT		0x90
 #define DRV260X_DEF_OD_CLAMP_VOLT	0x90
 
-/**
+/*
  * Rated and Overdriver Voltages:
  * Calculated using the formula r = v * 255 / 5.6
  * where r is what will be written to the register
  * and v is the rated or overdriver voltage of the actuator
- **/
+ */
 static int drv260x_calculate_voltage(unsigned int voltage)
 {
 	return (voltage * 255 / 5600);
-- 
2.25.1


  parent reply	other threads:[~2020-11-04 16:25 UTC|newest]

Thread overview: 48+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-04 16:24 [PATCH 00/20] [Set 1/2] Rid W=1 issues from Input Lee Jones
2020-11-04 16:24 ` [PATCH 01/20] input: rmi4: rmi_bus: Fix misnaming of '__rmi_register_function_handler's 'owner' param Lee Jones
2020-11-04 16:24 ` [PATCH 02/20] input: mouse: cyapa: Fix misnaming of 'cyapa_i2c_write's 'reg' param Lee Jones
2020-11-04 17:14   ` Benson Leung
2020-11-09  6:31   ` Dmitry Torokhov
2020-11-04 16:24 ` [PATCH 03/20] input: mouse: cyapa_gen5: Fix obvious abuse of kernel-doc format Lee Jones
2020-11-09  6:32   ` Dmitry Torokhov
2020-11-04 16:24 ` [PATCH 04/20] input: misc: ab8500-ponkey: Fix incorrect name in 'ab8500_ponkey' doc header Lee Jones
2020-11-09  6:32   ` Dmitry Torokhov
2020-11-04 16:24 ` [PATCH 05/20] input: rmi4: rmi_f01: Struct headers are expected to start with 'struct <name>' Lee Jones
2020-11-10  0:49   ` Dmitry Torokhov
2020-11-04 16:24 ` [PATCH 06/20] include: input: elan-i2c-ids: Mark 'elan_acpi_id' as __maybe_unused Lee Jones
2020-11-04 22:50   ` Dmitry Torokhov
2020-11-05  9:13     ` Lee Jones
2020-11-06  7:28       ` Dmitry Torokhov
2020-11-06  7:37         ` Lee Jones
2020-11-12 10:44   ` [PATCH] input: mouse: elan_i2c_core: Move header inclusion inside Lee Jones
2020-11-18  0:33     ` Dmitry Torokhov
2020-11-04 16:24 ` [PATCH 07/20] input: keyboard: cros_ec_keyb: Struct headers should start with 'struct <name>' Lee Jones
2020-11-04 17:15   ` Benson Leung
2020-11-04 16:24 ` [PATCH 08/20] input: rmi4: rmi_f11: Struct headers are expected to " Lee Jones
2020-11-04 16:24 ` [PATCH 09/20] input: touchscreen: resistive-adc-touch: Struct headers should " Lee Jones
2020-11-09  6:33   ` Dmitry Torokhov
2020-11-04 16:24 ` [PATCH 10/20] input: mouse: synaptics: Place braces around empty if() body Lee Jones
2020-11-06  7:26   ` Dmitry Torokhov
2020-11-06  7:40     ` Lee Jones
2020-11-06  7:45     ` Joe Perches
2020-11-06  8:18       ` Lee Jones
2020-11-04 16:24 ` [PATCH 11/20] input: keyboard: gpio_keys: Fix misnamed function parameter 'dev' Lee Jones
2020-11-09  6:25   ` Dmitry Torokhov
2020-11-04 16:24 ` [PATCH 12/20] input: mouse: elantech: Demote obvious abuse of kernel-doc header Lee Jones
2020-11-09  6:25   ` Dmitry Torokhov
2020-11-04 16:24 ` [PATCH 13/20] input: rmi4: rmi_f54: Provide some missing 'REPORT_TYPE' enums Lee Jones
2020-11-04 16:24 ` [PATCH 14/20] input: rmi4: rmi_i2c: Provide some missing descriptions for struct members Lee Jones
2020-11-04 16:24 ` [PATCH 15/20] input: touchscreen: cyttsp4_core: Move 'cyttsp4_tch_abs_string' to the only file that references it Lee Jones
2020-11-09  6:36   ` Dmitry Torokhov
2020-11-09  9:17     ` Lee Jones
2020-11-04 16:24 ` Lee Jones [this message]
2020-11-09  6:13   ` [PATCH 16/20] input: misc: drv260x: Fix kernel-doc formatting and remove one abuse Dmitry Torokhov
2020-11-04 16:24 ` [PATCH 17/20] input: misc: drv2665: Fix formatting expected by kernel-doc Lee Jones
2020-11-09  6:16   ` Dmitry Torokhov
2020-11-04 16:24 ` [PATCH 18/20] input: misc: drv2667: Fix formatting and add missing member docs Lee Jones
2020-11-09  6:17   ` Dmitry Torokhov
2020-11-04 16:24 ` [PATCH 19/20] input: keyboard: nomadik-ske-keypad: Provide some missing struct " Lee Jones
2020-11-09  6:18   ` Dmitry Torokhov
2020-11-04 16:24 ` [PATCH 20/20] input: keyboard: pmic8xxx-keypad: Fix kernel-doc formatting Lee Jones
2020-11-09 22:02   ` Dmitry Torokhov
2020-11-06 13:24 ` [PATCH 00/20] [Set 1/2] Rid W=1 issues from Input Lee Jones

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=20201104162427.2984742-17-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=dmitry.torokhov@gmail.com \
    --cc=dmurphy@ti.com \
    --cc=linux-input@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /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;
as well as URLs for NNTP newsgroup(s).