[PATCH libinput] doc: inverse event type restriction of x and y accessors

[Peter Hutterer]

On Thu, Aug 20, 2015 at 10:33:32AM +0200, Andreas Pokorny wrote:
> Signed-off-by: Andreas Pokorny <andreas.pokorny at canonical.com>

merged, thanks.

Cheers,
   Peter

> ---
>  src/libinput.h | 12 ++++++++----
>  1 file changed, 8 insertions(+), 4 deletions(-)
> 
> diff --git a/src/libinput.h b/src/libinput.h
> index f2b77b3..88b3c05 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
> -- 
> 2.1.4
>