From 911059b1e7a0ffb25de1f0395d0e6b88b998e77a Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Mon, 9 Feb 2015 09:45:33 +1000 Subject: [PATCH] doc: add a dot graph for device groups and two missing @refs Signed-off-by: Peter Hutterer --- src/libinput.h | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/src/libinput.h b/src/libinput.h index 3b179a8..577c006 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. -- 2.7.4