[PATCH libinput 1/6] Calling has_axis on a non-axis pointer event is a bug, note this

[Peter Hutterer]

Signed-off-by: Peter Hutterer <peter.hutterer at who-t.net>
---
 src/libinput.h | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/libinput.h b/src/libinput.h
index ca08c3e..9a7829e 100644
--- a/src/libinput.h
+++ b/src/libinput.h
@@ -668,6 +668,12 @@ libinput_event_pointer_get_seat_button_count(
  * libinput_event_pointer_get_axis_value() returns a value of 0, the event
  * is a scroll stop event.
  *
+ * For pointer events that are not of type @ref LIBINPUT_EVENT_POINTER_AXIS,
+ * this function returns 0.
+ *
+ * @note It is an application bug to call this function for events other than
+ * @ref LIBINPUT_EVENT_POINTER_AXIS.
+ *
  * @return Non-zero if this event contains a value for this axis
  */
 int
-- 
2.1.0