doc: Rephrase touch event slot description to be more event centric
authorJonas Ådahl <jadahl@gmail.com>
Tue, 11 Feb 2014 22:30:28 +0000 (23:30 +0100)
committerJonas Ådahl <jadahl@gmail.com>
Mon, 17 Feb 2014 19:12:19 +0000 (20:12 +0100)
It is unclear what "current" means as events are asynchronous, and
since a slot is associated with a touch event rather than a device,
change the description to reflect this.

Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
src/libinput.h

index c335ece..4b0680c 100644 (file)
@@ -555,12 +555,12 @@ libinput_event_touch_get_time(struct libinput_event_touch *event);
 /**
  * @ingroup event_touch
  *
- * Get the currently active slot on this device. See the kernel's multitouch
+ * Get the slot of this touch event. See the kernel's multitouch
  * protocol B documentation for more information.
  *
  * @note this function should not be called for LIBINPUT_EVENT_TOUCH_FRAME.
  *
- * @return The currently active slot on this multitouch device
+ * @return The slot of this touch event
  */
 uint32_t
 libinput_event_touch_get_slot(struct libinput_event_touch *event);