From: Jonas Ådahl <jadahl@gmail.com>
Date: Sat, 25 Jan 2014 10:52:33 +0000 (+0100)
Subject: Document the LIBINPUT_EVENT_NONE event type
X-Git-Tag: 0.1.0~46
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=849b80a1e6e15743db5a9f21d6ad109fb0802ab4;p=platform%2Fupstream%2Flibinput.git

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 af1614e9..ddaeb738 100644
--- 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,
 
 	/**