Document the LIBINPUT_EVENT_NONE event type

Signed-off-by: Jonas Ådahl <jadahl@gmail.com>

diff --git a/src/libinput.h b/src/libinput.h
index af1614e94bd1afc0e4c7a9d160baeb99f0c8dd93..ddaeb738891b07f7b6a17168534189d039533f40 100644 (file)
--- a/src/libinput.h
+++ b/src/libinput.h
@@ -119,6 +119,11 @@ enum libinput_touch_type {
  * Event type for events returned by libinput_get_event().
  */
 enum libinput_event_type {
+       /**
+        * This is not a real event type, and is only used to tell the user that
+        * no new event is available in the queue. See
+        * libinput_next_event_type().
+        */
        LIBINPUT_EVENT_NONE = 0,
 
        /**