aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKirill Primak <vyivel@eclair.cafe>2022-11-13 01:30:22 +0300
committerKirill Primak <vyivel@eclair.cafe>2022-11-13 01:35:12 +0300
commit627a5c511278e67c3c308cdc6a639cbb490f48c3 (patch)
tree7ab2089fc8c348cde735f2166a71c723570b30e5
parent2b22a1047840912c8c86781282faa5aa08684f64 (diff)
xwayland: fix wlr_xwayland_surface_from_wlr_surface() docs
32daa43a454bcea1306ad0976fd4161ce8c7e86f has removed the asymmetry in the relationship of a wlr_surface and an unmapped wlr_xwayland_surface, when wlr_surface.role_data wasn't NULL but wlr_xwayland_surface.surface was. However, this also means that wlr_xwayland_surface_from_wlr_surface() now returns NULL if the wlr_surface is unmapped. Fix the documentation to reflect this.
-rw-r--r--include/wlr/xwayland/xwayland.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/include/wlr/xwayland/xwayland.h b/include/wlr/xwayland/xwayland.h
index fd161937..372ab9a8 100644
--- a/include/wlr/xwayland/xwayland.h
+++ b/include/wlr/xwayland/xwayland.h
@@ -232,7 +232,7 @@ bool wlr_surface_is_xwayland_surface(struct wlr_surface *surface);
* Get a struct wlr_xwayland_surface from a struct wlr_surface.
* Asserts that the surface has the xwayland surface role.
* May return NULL even if the surface has the xwayland surface role if the
- * corresponding xwayland surface has been destroyed.
+ * corresponding xwayland surface has been unmapped or destroyed.
*/
struct wlr_xwayland_surface *wlr_xwayland_surface_from_wlr_surface(
struct wlr_surface *surface);