[mutter/wip/nielsdg/add-wayland-buf-docs: 208/208] wayland: Add documentation to wayland_shell_init

[Niels De Graef <nielsdg src gnome org>]

commit 5c986060f0afe1a59fb4b402966ed214371f45f6
Author: Niels De Graef <niels degraef barco com>
Date:   Mon Oct 21 13:31:25 2019 +0200

    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 aec7ed2bb..4122acc11 100644
--- a/src/wayland/meta-wayland-surface.c
+++ b/src/wayland/meta-wayland-surface.c
@@ -1467,6 +1467,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)
 {