HID: sensor-hub: Fix typo and improve documentation for sensor_hub_remove_callback()
authorChelsy Ratnawat <chelsyratnawat2001@gmail.com>
Fri, 2 May 2025 00:36:55 +0000 (17:36 -0700)
committerJonathan Cameron <Jonathan.Cameron@huawei.com>
Wed, 21 May 2025 13:20:29 +0000 (14:20 +0100)
Fixed a typo in "registered" and improved grammar for better readability
and consistency with kernel-doc standards. No functional changes.

Signed-off-by: Chelsy Ratnawat <chelsyratnawat2001@gmail.com>
Reviewed-by: David Lechner <dlechner@baylibre.com>
Link: https://patch.msgid.link/20250502003655.1943000-1-chelsyratnawat2001@gmail.com
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
include/linux/hid-sensor-hub.h

index c27329e2a5ad57851c55cbdaefc382ae6512a350..0f9f7df865db837e8d17de336bfcadb617ba1bc7 100644 (file)
@@ -128,12 +128,13 @@ int sensor_hub_register_callback(struct hid_sensor_hub_device *hsdev,
                        struct hid_sensor_hub_callbacks *usage_callback);
 
 /**
-* sensor_hub_remove_callback() - Remove client callbacks
+* sensor_hub_remove_callback() - Remove client callback
 * @hsdev:      Hub device instance.
-* @usage_id:   Usage id of the client (E.g. 0x200076 for Gyro).
+* @usage_id:   Usage id of the client (e.g. 0x200076 for gyro).
 *
-* If there is a callback registred, this call will remove that
-* callbacks, so that it will stop data and event notifications.
+* Removes a previously registered callback for the given usage_id
+* and hsdev. Once removed, the client will no longer receive data or
+* event notifications.
 */
 int sensor_hub_remove_callback(struct hid_sensor_hub_device *hsdev,
                        u32 usage_id);