metacity r3685 - in trunk: . src/core

[tthurman svn gnome org]

Author: tthurman
Date: Tue Apr 22 12:15:05 2008
New Revision: 3685
URL: http://svn.gnome.org/viewvc/metacity?rev=3685&view=rev

Log:
2008-04-22  Thomas Thurman  <tthurman gnome org>

        * src/core/effects.c: a few comments



Modified:
   trunk/ChangeLog
   trunk/src/core/effects.c

Modified: trunk/src/core/effects.c
==============================================================================
--- trunk/src/core/effects.c	(original)
+++ trunk/src/core/effects.c	Tue Apr 22 12:15:05 2008
@@ -21,6 +21,16 @@
  * 02111-1307, USA.
  */
 
+
+/**
+ * \file effects.c "Special effects" other than compositor effects.
+ * 
+ * Before we had a serious compositor, we supported swooping
+ * rectangles for minimising and so on.  These are still supported
+ * today, even when the compositor is enabled.
+ */
+
+
 #include <config.h>
 #include "effects.h"
 #include "display.h"
@@ -256,14 +266,15 @@
 #endif
 }
 
+/**
+ * A hack to force the X server to synchronize with the
+ * graphics hardware.
+ */
 static void
 graphics_sync (BoxAnimationContext *context)
 {
   XImage *image;
   
-  /* A hack to force the X server to synchronize with the
-   * graphics hardware
-   */
   image = XGetImage (context->screen->display->xdisplay,
 		     context->screen->xroot,
 		     0, 0, 1, 1,