[gnome-shell/wip/nielsdg/cleanup-plugin-boilerplate: 10/13] plugin: add some comments on its purpose

[Niels De Graef <nielsdg src gnome org>]

commit cb452e07484b9b885e210e12bb06acd5dc8aeaf7
Author: Niels De Graef <nielsdegraef gmail com>
Date:   Tue Dec 25 15:40:10 2018 +0100

    plugin: add some comments on its purpose

 src/gnome-shell-plugin.c | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
---
diff --git a/src/gnome-shell-plugin.c b/src/gnome-shell-plugin.c
index fa8410d40..dafe0ec75 100644
--- a/src/gnome-shell-plugin.c
+++ b/src/gnome-shell-plugin.c
@@ -21,6 +21,20 @@
  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * SECTION:gnome-shell-plugin
+ * @title: GnomeShellPlugin
+ * @short_description: GNOME Shell's Mutter plugin
+ *
+ * GnomeShellPlugin is the entry point for for GNOME Shell into and out of
+ * Mutter. By registering itself into Mutter using
+ * meta_plugin_manager_set_plugin_type(), Mutter will call the vfuncs of the
+ * plugin at the appropriate time.
+ *
+ * The funcions in in #GnomeShellPlugin are all just stubs, which just call the
+ * similar methods in #GnomeShellWm.
+ */
+
 #include "config.h"
 
 #include <stdlib.h>