From 8582b45c9ed25dd9f4742f02a3c5725cc6db2e6f Mon Sep 17 00:00:00 2001
From: Simon Ser <contact@emersion.fr>
Date: Wed, 17 Apr 2024 11:30:34 +0200
Subject: [PATCH] xdg-shell: document struct wlr_xdg_toplevel_configure

---
 include/wlr/types/wlr_xdg_shell.h | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/include/wlr/types/wlr_xdg_shell.h b/include/wlr/types/wlr_xdg_shell.h
index 940f35ec6..854185bfc 100644
--- a/include/wlr/types/wlr_xdg_shell.h
+++ b/include/wlr/types/wlr_xdg_shell.h
@@ -153,14 +153,23 @@ enum wlr_xdg_toplevel_configure_field {
 	WLR_XDG_TOPLEVEL_CONFIGURE_WM_CAPABILITIES = 1 << 1,
 };
 
+/**
+ * State set in an toplevel configure sequence.
+ */
 struct wlr_xdg_toplevel_configure {
+	// Bitmask of optional fields which are set
 	uint32_t fields; // enum wlr_xdg_toplevel_configure_field
+
+	// The following fields must always be set to reflect the current state
 	bool maximized, fullscreen, resizing, activated, suspended;
 	uint32_t tiled; // enum wlr_edges
 	int32_t width, height;
+
+	// Only for WLR_XDG_TOPLEVEL_CONFIGURE_BOUNDS
 	struct {
 		int32_t width, height;
 	} bounds;
+	// Only for WLR_XDG_TOPLEVEL_CONFIGURE_WM_CAPABILITIES
 	uint32_t wm_capabilities; // enum wlr_xdg_toplevel_wm_capabilities
 };