switch: add docs

1 files changed, 7 insertions, 1 deletions

diff --git a/include/wlr/types/wlr_switch.h b/include/wlr/types/wlr_switch.h
index b560f0ba..641df199 100644
--- a/include/wlr/types/wlr_switch.h
+++ b/include/wlr/types/wlr_switch.h
@@ -15,13 +15,19 @@
 
 struct wlr_switch_impl;
 
+/**
+ * A switch input device. Typically a switch input device can indicate whether
+ * a laptop lid is opened or closed, or whether tablet mode is enabled.
+ *
+ * See https://wayland.freedesktop.org/libinput/doc/latest/switches.html
+ */
 struct wlr_switch {
 	struct wlr_input_device base;
 
 	const struct wlr_switch_impl *impl;
 
 	struct {
-		struct wl_signal toggle;
+		struct wl_signal toggle; // struct wlr_switch_toggle_event
 	} events;
 
 	void *data;