From 4233ecd5398f015403519ca5dd0d980f5df2ffa3 Mon Sep 17 00:00:00 2001
From: Niels De Graef <niels.degraef@barco.com>
Date: Mon, 21 Oct 2019 13:31:25 +0200
Subject: [PATCH] wayland: Add documentation to wayland_shell_init

Especially preventing the confusion that it might only initalize the
wl_shell interface.

https://gitlab.gnome.org/GNOME/mutter/merge_requests/871
---
 src/wayland/meta-wayland-surface.c | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/wayland/meta-wayland-surface.c b/src/wayland/meta-wayland-surface.c
index e10467502..b6803fb90 100644
--- a/src/wayland/meta-wayland-surface.c
+++ b/src/wayland/meta-wayland-surface.c
@@ -1478,6 +1478,13 @@ meta_wayland_surface_begin_grab_op (MetaWaylandSurface *surface,
                                      x, y);
 }
 
+/**
+ * meta_wayland_shell_init:
+ * @compositor: The #MetaWaylandCompositor object
+ *
+ * Initializes the Wayland interfaces providing features that deal with
+ * desktop-specific conundrums, like XDG shell, wl_shell (deprecated), etc.
+ */
 void
 meta_wayland_shell_init (MetaWaylandCompositor *compositor)
 {