From: Andreas Pokorny <andreas.pokorny@canonical.com>
Date: Thu, 20 Aug 2015 08:33:32 +0000 (+0200)
Subject: doc: inverse event type restriction of x and y accessors
X-Git-Tag: 1.0.0~5
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=a2c9787a8bfa79f1ad2dce6e4bceda6ede3f5b49;p=platform%2Fupstream%2Flibinput.git

doc: inverse event type restriction of x and y accessors

Signed-off-by: Andreas Pokorny <andreas.pokorny@canonical.com>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
---

diff --git a/src/libinput.h b/src/libinput.h
index f2b77b34..88b3c05f 100644
--- a/src/libinput.h
+++ b/src/libinput.h
@@ -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