From: Peter Hutterer <peter.hutterer@who-t.net>
Date: Tue, 9 Dec 2014 03:37:04 +0000 (+1000)
Subject: doc: document the base structures so they show up in doxygen
X-Git-Tag: 0.8.0~64
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=0e9beca049e89d25d506f6b96dc659621499a44d;p=platform%2Fupstream%2Flibinput.git

doc: document the base structures so they show up in doxygen

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 d6e04462..22b0cfe2 100644
--- a/src/libinput.h
+++ b/src/libinput.h
@@ -302,8 +302,31 @@ enum libinput_event_type {
 	LIBINPUT_EVENT_TOUCH_FRAME
 };
 
+/**
+ * @ingroup base
+ * @struct libinput
+ *
+ * A handle for accessing libinput. This struct is refcounted, use
+ * libinput_ref() and libinput_unref().
+ */
 struct libinput;
+
+/**
+ * @ingroup device
+ * @struct libinput_device
+ *
+ * A base handle for accessing libinput devices. This struct is
+ * refcounted, use libinput_device_ref() and libinput_device_unref().
+ */
 struct libinput_device;
+
+/**
+ * @ingroup seat
+ * @struct libinput_seat
+ *
+ * The base handle for accessing libinput seats. This struct is
+ * refcounted, use libinput_seat_ref() and libinput_seat_unref().
+ */
 struct libinput_seat;
 
 /**
@@ -919,6 +942,17 @@ libinput_event_touch_get_base_event(struct libinput_event_touch *event);
  * @defgroup base Initialization and manipulation of libinput contexts
  */
 
+/**
+ * @ingroup base
+ * @struct libinput_interface
+ *
+ * libinput does not open file descriptors to devices directly, instead
+ * open_restricted() and close_restricted() are called for each path that
+ * must be opened.
+ *
+ * @see libinput_udev_create_context
+ * @see libinput_path_create_context
+ */
 struct libinput_interface {
 	/**
 	 * Open the device at the given path with the flags provided and