summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@who-t.net>2021-01-08 09:58:16 +1000
committerPeter Hutterer <peter.hutterer@who-t.net>2021-01-08 09:58:16 +1000
commit70881516f214a7d042120fcb5aa3815e52f8875d (patch)
treee1aada20bb7c4fedd31b548bc93a0dba3eb0cd54
parent510bde8f47718f359b6a9334983d33a48076f107 (diff)
downloadlibevdev-70881516f214a7d042120fcb5aa3815e52f8875d.tar.gz
doc: fix conflicting documentation for libevdev_get_event_value()
Yes, the value we return is from the currently active slot, but there are a few niche cases where the active slot changes from what the client may think it is. So let's call it undefined like the other half of the documentation already does. Fixes #20 Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
-rw-r--r--libevdev/libevdev.h3
1 files changed, 1 insertions, 2 deletions
diff --git a/libevdev/libevdev.h b/libevdev/libevdev.h
index 6ffcda7..1392c74 100644
--- a/libevdev/libevdev.h
+++ b/libevdev/libevdev.h
@@ -1515,8 +1515,7 @@ const struct input_absinfo* libevdev_get_abs_info(const struct libevdev *dev, un
* the event.
*
* If the device supports ABS_MT_SLOT, the value returned for any ABS_MT_*
- * event code is the value of the currently active slot. You should use
- * libevdev_get_slot_value() instead.
+ * event code is undefined. Use libevdev_get_slot_value() instead.
*
* @param dev The evdev device, already initialized with libevdev_set_fd()
* @param type The event type for the code to query (EV_SYN, EV_REL, etc.)