From c93cd4a096b9e37df5cdc01f0e49b8193034f73a Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Fri, 19 Dec 2008 17:48:30 +0000 Subject: [PATCH] [docs] Documentation fixes for CairoTexture Sync up the arguments name inside the gtk-doc annotations with their name inside the function declaration in the header file. --- clutter/clutter-cairo-texture.c | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/clutter/clutter-cairo-texture.c b/clutter/clutter-cairo-texture.c index d7680787b..f638ff9c9 100644 --- a/clutter/clutter-cairo-texture.c +++ b/clutter/clutter-cairo-texture.c @@ -554,7 +554,7 @@ intersect_rectangles (ClutterCairoTextureRectangle *a, /** * clutter_cairo_texture_create_region: - * @cairo: a #ClutterCairoTexture + * @self: a #ClutterCairoTexture * @x_offset: offset of the region on the X axis * @y_offset: offset of the region on the Y axis * @width: width of the region, or -1 for the full surface width @@ -563,8 +563,12 @@ intersect_rectangles (ClutterCairoTextureRectangle *a, * Creates a new Cairo context that will updat the region defined * by @x_offset, @y_offset, @width and @height. * + * Do not call this function within the paint virtual + * function or from a callback to the #ClutterActor::paint + * signal. + * * Return value: a newly created Cairo context. Use cairo_destroy() - * to upload the contents of the context when done drawing. + * to upload the contents of the context when done drawing * * Since: 1.0 */ @@ -634,15 +638,19 @@ clutter_cairo_texture_create_region (ClutterCairoTexture *self, /** * clutter_cairo_texture_create: - * @cairo: a #ClutterCairoTexture + * @self: a #ClutterCairoTexture * * Creates a new Cairo context for the @cairo texture. It is * similar to using clutter_cairo_texture_create_region() with @x_offset * and @y_offset of 0, @width equal to the @cairo texture surface width * and @height equal to the @cairo texture surface height. * + * Do not call this function within the paint virtual + * function or from a callback to the #ClutterActor::paint + * signal. + * * Return value: a newly created Cairo context. Use cairo_destroy() - * to upload the contents of the context when done drawing. + * to upload the contents of the context when done drawing * * Since: 1.0 */ @@ -687,7 +695,7 @@ clutter_cairo_set_source_color (cairo_t *cr, } /** - * clutter_cairo_texture_surface_set_size: + * clutter_cairo_texture_set_surface_size: * @self: a #ClutterCairoTexture * @width: the new width of the surface * @height: the new height of the surface