[mutter] [mutter_plugin_get_windows] Document it

[Colin Walters <walters src gnome org>]

commit d8ffc3c1873c629c5acdce3fcc9aa39558dba607
Author: Colin Walters <walters verbum org>
Date:   Mon Sep 28 16:42:12 2009 -0400

    [mutter_plugin_get_windows] Document it

 src/compositor/mutter-plugin.c |   12 ++++++++++++
 1 files changed, 12 insertions(+), 0 deletions(-)
---
diff --git a/src/compositor/mutter-plugin.c b/src/compositor/mutter-plugin.c
index 83b936f..276f412 100644
--- a/src/compositor/mutter-plugin.c
+++ b/src/compositor/mutter-plugin.c
@@ -459,6 +459,18 @@ mutter_plugin_set_stage_input_region (MutterPlugin *plugin,
   mutter_set_stage_input_region (screen, region);
 }
 
+/**
+ * mutter_plugin_get_windows:
+ * @plugin: A #MutterPlugin
+ *
+ * This function returns all of the #MetaWindow objects referenced by Mutter, including
+ * override-redirect windows.  The returned list is a snapshot of Mutter's current
+ * stacking order, with the topmost window last.
+ *
+ * The 'restacked' signal of #MetaScreen signals when this value has changed.
+ *
+ * Returns: (transfer none) (element-type MetaWindow): Windows in stacking order, topmost last
+ */
 GList *
 mutter_plugin_get_windows (MutterPlugin *plugin)
 {