compositor: Fix the documentation for surface->configure
authorJasper St. Pierre <jstpierre@mecheye.net>
Mon, 28 Apr 2014 15:19:27 +0000 (11:19 -0400)
committerKristian Høgsberg <krh@bitplanet.net>
Thu, 1 May 2014 03:48:55 +0000 (20:48 -0700)
It's called on commit, not on attach. Additionally, correct the
interface name to be wl_surface, not surface.

src/compositor.h

index 1fb5ffa..1997e54 100644 (file)
@@ -910,9 +910,10 @@ struct weston_surface {
        } pending;
 
        /*
-        * If non-NULL, this function will be called on surface::attach after
-        * a new buffer has been set up for this surface. The integer params
-        * are the sx and sy paramerters supplied to surface::attach .
+        * If non-NULL, this function will be called on
+        * wl_surface::commit after a new buffer has been set up for
+        * this surface. The integer params are the sx and sy
+        * parameters supplied to wl_surface::attach.
         */
        void (*configure)(struct weston_surface *es, int32_t sx, int32_t sy);
        void *configure_private;