All of lore.kernel.org
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org, Jiri Kosina <jikos@kernel.org>,
	Benjamin Tissoires <benjamin.tissoires@redhat.com>,
	Henrik Rydberg <rydberg@bitmath.org>,
	Lopez Casado <nlopezcasad@logitech.com>,
	linux-input@vger.kernel.org
Subject: [PATCH 16/25] HID: hid-logitech-hidpp: Fix conformant kernel-doc header and demote abuses
Date: Fri, 26 Mar 2021 14:34:49 +0000	[thread overview]
Message-ID: <20210326143458.508959-18-lee.jones@linaro.org> (raw)
In-Reply-To: <20210326143458.508959-1-lee.jones@linaro.org>

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

 drivers/hid/hid-logitech-hidpp.c:275: warning: Function parameter or member 'hidpp' not described in 'hidpp_send_message_sync'
 drivers/hid/hid-logitech-hidpp.c:275: warning: Function parameter or member 'message' not described in 'hidpp_send_message_sync'
 drivers/hid/hid-logitech-hidpp.c:275: warning: Function parameter or member 'response' not described in 'hidpp_send_message_sync'
 drivers/hid/hid-logitech-hidpp.c:275: warning: expecting prototype for and something else(). Prototype was for hidpp_send_message_sync() instead
 drivers/hid/hid-logitech-hidpp.c:427: warning: wrong kernel-doc identifier on line:
 drivers/hid/hid-logitech-hidpp.c:470: warning: Function parameter or member 'input_dev' not described in 'hidpp_scroll_counter_handle_scroll'
 drivers/hid/hid-logitech-hidpp.c:1894: warning: Function parameter or member 'hidpp' not described in 'hidpp_touchpad_fw_items_set'
 drivers/hid/hid-logitech-hidpp.c:1894: warning: Function parameter or member 'feature_index' not described in 'hidpp_touchpad_fw_items_set'
 drivers/hid/hid-logitech-hidpp.c:1894: warning: Function parameter or member 'items' not described in 'hidpp_touchpad_fw_items_set'
 drivers/hid/hid-logitech-hidpp.c:1894: warning: expecting prototype for send a set state command to the device by reading the current items(). Prototype was for hidpp_touchpad_fw_items_set() instead

Cc: Jiri Kosina <jikos@kernel.org>
Cc: Benjamin Tissoires <benjamin.tissoires@redhat.com>
Cc: Henrik Rydberg <rydberg@bitmath.org>
Cc: Lopez Casado <nlopezcasad@logitech.com>
Cc: linux-input@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/hid/hid-logitech-hidpp.c | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/drivers/hid/hid-logitech-hidpp.c b/drivers/hid/hid-logitech-hidpp.c
index d459e2dbe6474..d598094dadd0c 100644
--- a/drivers/hid/hid-logitech-hidpp.c
+++ b/drivers/hid/hid-logitech-hidpp.c
@@ -261,7 +261,7 @@ static int __hidpp_send_report(struct hid_device *hdev,
 	return ret == fields_count ? 0 : -1;
 }
 
-/**
+/*
  * hidpp_send_message_sync() returns 0 in case of success, and something else
  * in case of a failure.
  * - If ' something else' is positive, that means that an error has been raised
@@ -423,7 +423,7 @@ static inline bool hidpp_report_is_connect_event(struct hidpp_device *hidpp,
 		(report->rap.sub_id == 0x41));
 }
 
-/**
+/*
  * hidpp_prefix_name() prefixes the current given name with "Logitech ".
  */
 static void hidpp_prefix_name(char **name, int name_length)
@@ -454,6 +454,7 @@ static void hidpp_prefix_name(char **name, int name_length)
  * hidpp_scroll_counter_handle_scroll() - Send high- and low-resolution scroll
  *                                        events given a high-resolution wheel
  *                                        movement.
+ * @input_dev: Pointer to the input device
  * @counter: a hid_scroll_counter struct describing the wheel.
  * @hi_res_value: the movement of the wheel, in the mouse's high-resolution
  *                units.
@@ -1884,7 +1885,7 @@ struct hidpp_touchpad_fw_items {
 	uint8_t persistent;
 };
 
-/**
+/*
  * send a set state command to the device by reading the current items->state
  * field. items is then filled with the current state.
  */
-- 
2.27.0


  parent reply	other threads:[~2021-03-26 14:36 UTC|newest]

Thread overview: 53+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-26 14:34 [RESEND 00/25] Rid W=1 warnings from HID Lee Jones
2021-03-26 14:34 ` Lee Jones
2021-03-26 14:34 ` Lee Jones
2021-03-26 14:34 ` Lee Jones
2021-03-26 14:34   ` Lee Jones
2021-03-26 14:34   ` Lee Jones
2021-03-26 14:34 ` [PATCH 01/25] HID: intel-ish-hid: Remove unused variable 'err' Lee Jones
2021-03-26 14:34 ` [PATCH 02/25] HID: ishtp-hid-client: Move variable to where it's actually used Lee Jones
2021-03-26 14:34 ` [PATCH 03/25] HID: intel-ish-hid: pci-ish: Remove unused variable 'ret' Lee Jones
2021-03-26 14:34 ` [PATCH 04/25] HID: intel-ish: Supply some missing param descriptions Lee Jones
2021-03-26 14:34 ` [PATCH 05/25] HID: intel-ish: Fix a naming disparity and a formatting error Lee Jones
2021-03-26 14:34 ` [PATCH 06/25] HID: usbhid: Repair a formatting issue in a struct description Lee Jones
2021-04-07 16:56   ` Benjamin Tissoires
2021-04-08  7:05     ` Lee Jones
2021-03-26 14:34 ` [PATCH 07/25] HID: intel-ish-hid: Fix a little doc-rot Lee Jones
2021-03-26 14:34 ` [PATCH 08/25] HID: usbhid: hid-pidff: Demote a couple kernel-doc abuses Lee Jones
2021-03-26 14:34 ` [PATCH 09/25] HID: hid-alps: Correct struct misnaming Lee Jones
2021-03-26 14:34 ` [PATCH 10/25] HID: intel-ish-hid: Fix potential copy/paste error Lee Jones
2021-03-26 14:34 ` [PATCH 11/25] HID: hid-core: Fix incorrect function name in header Lee Jones
2021-03-26 14:34 ` [PATCH 12/25] HID: intel-ish-hid: ipc: Correct fw_reset_work_fn() " Lee Jones
2021-03-26 14:34 ` [PATCH 13/25] HID: ishtp-hid-client: Fix incorrect function name report_bad_packet() Lee Jones
2021-03-26 14:34 ` [PATCH 14/25] HID: hid-kye: Fix incorrect function name for kye_tablet_enable() Lee Jones
2021-03-26 14:34 ` [PATCH 15/25] HID: hid-picolcd_core: Remove unused variable 'ret' Lee Jones
2021-03-26 14:34 ` Lee Jones [this message]
2021-03-26 14:34 ` [PATCH 17/25] HID: hid-uclogic-rdesc: Kernel-doc is for functions and structs Lee Jones
2021-03-26 14:34 ` [PATCH 18/25] HID: hid-thrustmaster: Demote a bunch of kernel-doc abuses Lee Jones
2021-03-26 14:34   ` Lee Jones
2021-03-26 14:34 ` [PATCH 19/25] HID: hid-uclogic-params: Ensure function names are present and correct in kernel-doc headers Lee Jones
2021-03-26 14:34 ` [PATCH 20/25] HID: hid-sensor-custom: Remove unused variable 'ret' Lee Jones
2021-03-29 11:26   ` Jonathan Cameron
2021-03-26 14:34 ` [PATCH 21/25] HID: wacom_sys: Demote kernel-doc abuse Lee Jones
2021-03-26 14:34 ` [PATCH 22/25] HID: hid-sensor-hub: Remove unused struct member 'quirks' Lee Jones
2021-03-29 11:27   ` Jonathan Cameron
2021-03-26 14:34 ` [PATCH 23/25] HID: hid-sensor-hub: Move 'hsdev' description to correct struct definition Lee Jones
2021-03-29 11:30   ` Jonathan Cameron
2021-03-29 13:00     ` Lee Jones
2021-03-29 15:22       ` Jonathan Cameron
2021-03-26 14:34 ` [PATCH 24/25] HID: intel-ish-hid: ishtp-fw-loader: Fix a bunch of formatting issues Lee Jones
2021-03-26 14:34   ` Lee Jones
2021-03-26 14:34 ` [PATCH 25/25] HID: ishtp-hid-client: Fix 'suggest-attribute=format' compiler warning Lee Jones
2021-04-06  8:56 ` [RESEND 00/25] Rid W=1 warnings from HID Lee Jones
2021-04-06  8:56   ` Lee Jones
2021-04-06  8:56   ` Lee Jones
2021-04-07 16:09   ` Benjamin Tissoires
2021-04-07 16:09     ` Benjamin Tissoires
2021-04-07 16:09     ` Benjamin Tissoires
2021-04-08  7:06     ` Lee Jones
2021-04-08  7:06       ` Lee Jones
2021-04-08  7:06       ` Lee Jones
2021-04-08 11:43       ` Benjamin Tissoires
2021-04-08 11:43         ` Benjamin Tissoires
2021-04-08 11:43         ` Benjamin Tissoires
  -- strict thread matches above, loose matches on Subject: below --
2021-03-24 17:33 [PATCH " Lee Jones
2021-03-24 17:33 ` [PATCH 16/25] HID: hid-logitech-hidpp: Fix conformant kernel-doc header and demote abuses 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=20210326143458.508959-18-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=benjamin.tissoires@redhat.com \
    --cc=jikos@kernel.org \
    --cc=linux-input@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=nlopezcasad@logitech.com \
    --cc=rydberg@bitmath.org \
    --subject='Re: [PATCH 16/25] HID: hid-logitech-hidpp: Fix conformant kernel-doc header and demote abuses' \
    /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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.