[PATCH libinput 4/6] doc: add the various events to the doxygen groups

Peter Hutterer peter.hutterer at who-t.net
Tue Dec 9 16:34:02 PST 2014


Makes them show up on the respective page and in the data structures list
doxygen generates.

Signed-off-by: Peter Hutterer <peter.hutterer at who-t.net>
---
 src/libinput.h | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/src/libinput.h b/src/libinput.h
index 682e16f..d6e0446 100644
--- a/src/libinput.h
+++ b/src/libinput.h
@@ -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;
 
 /**
-- 
2.1.0



More information about the wayland-devel mailing list