From: Peter Hutterer <peter.hutterer@who-t.net>
Date: Thu, 13 Mar 2014 04:28:26 +0000 (+1000)
Subject: Expand documentation for libinput_udev_create_for_seat
X-Git-Tag: 0.2.0~51
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=6b6bb8fdf92872e60c2e7950ce8275ce47b138e1;p=platform%2Fupstream%2Flibinput.git

Expand documentation for libinput_udev_create_for_seat

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Jonas Ådahl <jadahl@gmail.com>
---

diff --git a/src/libinput.h b/src/libinput.h
index d6bf9f8..dab24b7 100644
--- a/src/libinput.h
+++ b/src/libinput.h
@@ -691,6 +691,13 @@ struct libinput_interface {
  * the given seat ID. New devices or devices removed will appear as events
  * during libinput_dispatch.
  *
+ * libinput_udev_create_for_seat() succeeds even if no input device is
+ * available in this seat, or if devices are available but fail to open in
+ * @ref libinput_interface::open_restricted. Devices that do not have the
+ * minimum capabilities to be recognized as pointer, keyboard or touch
+ * device are ignored. Such devices and those that failed to open
+ * ignored until the next call to libinput_resume().
+ *
  * @param interface The callback interface
  * @param user_data Caller-specific data passed to the various callback
  * interfaces.