doc: fix conflicting documentation for libevdev_get_event_value()
authorPeter Hutterer <peter.hutterer@who-t.net>
Thu, 7 Jan 2021 23:58:16 +0000 (09:58 +1000)
committerPeter Hutterer <peter.hutterer@who-t.net>
Thu, 7 Jan 2021 23:58:16 +0000 (09:58 +1000)
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>
libevdev/libevdev.h

index 6ffcda73128abd173d9b0dac6f9b6ecdf5121c92..1392c74b3bea4c6b07baf18f095df7612070e7f9 100644 (file)
@@ -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.)