[mutter] Add small note to the docs about the actor containers in the compositor

[Florian Müllner <fmuellner src gnome org>]

commit 9df2d83aa01762db41975c0a3db6fb86cdd1f1d8
Author: Tomeu Vizoso <tomeu vizoso collabora com>
Date:   Fri Mar 15 11:29:19 2013 +0100

    Add small note to the docs about the actor containers in the compositor
    
    https://bugzilla.gnome.org/show_bug.cgi?id=695935

 src/compositor/compositor.c |   13 +++++++++++++
 1 files changed, 13 insertions(+), 0 deletions(-)
---
diff --git a/src/compositor/compositor.c b/src/compositor/compositor.c
index 2ef2d36..dbaaca2 100644
--- a/src/compositor/compositor.c
+++ b/src/compositor/compositor.c
@@ -51,6 +51,19 @@
  * is called. If the live_hidden_windows preference is set, windows will never
  * be unmapped.
  *
+ * # Containers #
+ *
+ * There's three containers in the stage that can be used to place actors, here
+ * are listed in the order in which they are painted:
+ *
+ * - window group, accessible with meta_get_window_group_for_screen()
+ * - top window group, accessible with meta_get_top_window_group_for_screen()
+ * - overlay group, accessible with meta_get_overlay_group_for_screen()
+ *
+ * Mutter will place actors representing windows in the window group, except for
+ * override-redirect windows (ie. popups and menus) which will be placed in the
+ * top window group. Mutter won't put any actors in the overlay group, but it's
+ * intended for compositors to place there panel, dashes, status bars, etc.
  */
 
 #include <config.h>