doc: add the various events to the doxygen groups
authorPeter Hutterer <peter.hutterer@who-t.net>
Tue, 9 Dec 2014 03:31:09 +0000 (13:31 +1000)
committerPeter Hutterer <peter.hutterer@who-t.net>
Thu, 11 Dec 2014 02:26:04 +0000 (12:26 +1000)
Makes them show up on the respective page and in the data structures list
doxygen generates.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Jonas Ã…dahl <jadahl@gmail.com>
src/libinput.h

index 682e16f2b348aabb2b6b75c50aa942cccb074ed4..d6e044623aac300f6fb6209594f3b2c5f235097b 100644 (file)
@@ -306,9 +306,38 @@ struct libinput;
 struct libinput_device;
 struct libinput_seat;
 
+/**
+ * @ingroup event
+ * @struct libinput_event
+ *
+ * The base event type. Use libinput_event_get_pointer_event() or similar to
+ * get the actual event type.
+ */
 struct libinput_event;
+
+/**
+ * @ingroup event
+ * @struct libinput_event_device_notify
+ *
+ * An event notifying the caller of a device being added or removed.
+ */
 struct libinput_event_device_notify;
+
+/**
+ * @ingroup event_keyboard
+ * @struct libinput_event_keyboard
+ *
+ * A keyboard event representing a key press/release.
+ */
 struct libinput_event_keyboard;
+
+/**
+ * @ingroup event_pointer
+ * @struct libinput_event_pointer
+ *
+ * A pointer event representing relative or absolute pointer movement,
+ * a button press/release or scroll axis events.
+ */
 struct libinput_event_pointer;
 
 /**