From: Peter Hutterer <peter.hutterer@who-t.net>
Date: Sun, 8 Feb 2015 23:45:33 +0000 (+1000)
Subject: doc: add a dot graph for device groups and two missing @refs
X-Git-Tag: 0.11.0~16
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=911059b1e7a0ffb25de1f0395d0e6b88b998e77a;p=platform%2Fupstream%2Flibinput.git

doc: add a dot graph for device groups and two missing @refs

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
---

diff --git a/src/libinput.h b/src/libinput.h
index 3b179a8c..577c0067 100644
--- a/src/libinput.h
+++ b/src/libinput.h
@@ -1421,9 +1421,9 @@ libinput_device_get_context(struct libinput_device *device);
  *
  * Get the device group this device is assigned to. Some physical
  * devices like graphics tablets are represented by multiple kernel
- * devices and thus by multiple struct libinput_device.
+ * devices and thus by multiple struct @ref libinput_device.
  *
- * libinput assigns these devices to the same libinput_device_group
+ * libinput assigns these devices to the same @ref libinput_device_group
  * allowing the caller to identify such devices and adjust configuration
  * settings accordingly. For example, setting a tablet to left-handed often
  * means turning it upside down. A touch device on the same tablet would
@@ -1435,6 +1435,33 @@ libinput_device_get_context(struct libinput_device *device);
  * LIBINPUT_EVENT_DEVICE_REMOVED. It is up to the caller to track how many
  * devices are in each device group.
  *
+ * @dot
+ * digraph groups_libinput {
+ *   rankdir="TB";
+ *   node [
+ *     shape="box";
+ *   ]
+ *
+ *   mouse [ label="mouse"; URL="\ref libinput_device"];
+ *   kbd [ label="keyboard"; URL="\ref libinput_device"];
+ *
+ *   pen [ label="tablet pen"; URL="\ref libinput_device"];
+ *   touch [ label="tablet touch"; URL="\ref libinput_device"];
+ *   pad [ label="tablet pad"; URL="\ref libinput_device"];
+ *
+ *   group1 [ label="group 1"; URL="\ref libinput_device_group"];
+ *   group2 [ label="group 2"; URL="\ref libinput_device_group"];
+ *   group3 [ label="group 3"; URL="\ref libinput_device_group"];
+ *
+ *   mouse -> group1
+ *   kbd -> group2
+ *
+ *   pen -> group3;
+ *   touch -> group3;
+ *   pad -> group3;
+ * }
+ * @enddot
+ *
  * Device groups do not get re-used once the last device in the group was
  * removed, i.e. unplugging and re-plugging a physical device with grouped
  * devices will return a different device group after every unplug.