doc: inverse event type restriction of x and y accessors
authorAndreas Pokorny <andreas.pokorny@canonical.com>
Thu, 20 Aug 2015 08:33:32 +0000 (10:33 +0200)
committerPeter Hutterer <peter.hutterer@who-t.net>
Fri, 21 Aug 2015 01:44:15 +0000 (11:44 +1000)
Signed-off-by: Andreas Pokorny <andreas.pokorny@canonical.com>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
src/libinput.h

index f2b77b3434d08d6b88c4f0688508bd32160dbae6..88b3c05f8f5226c8cdc43fddd01bb77720c82396 100644 (file)
@@ -894,7 +894,8 @@ libinput_event_touch_get_seat_slot(struct libinput_event_touch *event);
  * LIBINPUT_EVENT_TOUCH_MOTION, this function returns 0.
  *
  * @note It is an application bug to call this function for events of type
- * @ref LIBINPUT_EVENT_TOUCH_DOWN or @ref LIBINPUT_EVENT_TOUCH_MOTION.
+ * other than @ref LIBINPUT_EVENT_TOUCH_DOWN or @ref
+ * LIBINPUT_EVENT_TOUCH_MOTION.
  *
  * @param event The libinput touch event
  * @return The current absolute x coordinate
@@ -913,7 +914,8 @@ libinput_event_touch_get_x(struct libinput_event_touch *event);
  * LIBINPUT_EVENT_TOUCH_MOTION, this function returns 0.
  *
  * @note It is an application bug to call this function for events of type
- * @ref LIBINPUT_EVENT_TOUCH_DOWN or @ref LIBINPUT_EVENT_TOUCH_MOTION.
+ * other than @ref LIBINPUT_EVENT_TOUCH_DOWN or @ref
+ * LIBINPUT_EVENT_TOUCH_MOTION.
  *
  * @param event The libinput touch event
  * @return The current absolute y coordinate
@@ -931,7 +933,8 @@ libinput_event_touch_get_y(struct libinput_event_touch *event);
  * LIBINPUT_EVENT_TOUCH_MOTION, this function returns 0.
  *
  * @note It is an application bug to call this function for events of type
- * @ref LIBINPUT_EVENT_TOUCH_DOWN or @ref LIBINPUT_EVENT_TOUCH_MOTION.
+ * other than @ref LIBINPUT_EVENT_TOUCH_DOWN or @ref
+ * LIBINPUT_EVENT_TOUCH_MOTION.
  *
  * @param event The libinput touch event
  * @param width The current output screen width
@@ -951,7 +954,8 @@ libinput_event_touch_get_x_transformed(struct libinput_event_touch *event,
  * LIBINPUT_EVENT_TOUCH_MOTION, this function returns 0.
  *
  * @note It is an application bug to call this function for events of type
- * @ref LIBINPUT_EVENT_TOUCH_DOWN or @ref LIBINPUT_EVENT_TOUCH_MOTION.
+ * other than @ref LIBINPUT_EVENT_TOUCH_DOWN or @ref
+ * LIBINPUT_EVENT_TOUCH_MOTION.
  *
  * @param event The libinput touch event
  * @param height The current output screen height