isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-11-23 00:20:42 -05:00
Code Issues Packages Projects Releases Wiki Activity

[docs] Documentation fixes for CairoTexture

Browse Source 
Sync up the arguments name inside the gtk-doc annotations with their
name inside the function declaration in the header file.
This commit is contained in:
Emmanuele Bassi 2008-12-19 17:48:30 +00:00
parent 2f23003425
commit c93cd4a096
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
clutter/clutter-cairo-texture.c
View File

@ -554,7 +554,7 @@ intersect_rectangles (ClutterCairoTextureRectangle *a,
/** /**
* clutter_cairo_texture_create_region: * clutter_cairo_texture_create_region:
* @cairo: a #ClutterCairoTexture * @self: a #ClutterCairoTexture
* @x_offset: offset of the region on the X axis * @x_offset: offset of the region on the X axis
* @y_offset: offset of the region on the Y axis * @y_offset: offset of the region on the Y axis
* @width: width of the region, or -1 for the full surface width * @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 * Creates a new Cairo context that will updat the region defined
* by @x_offset, @y_offset, @width and @height. * by @x_offset, @y_offset, @width and @height.
* *
* <warning><para>Do not call this function within the paint virtual
* function or from a callback to the #ClutterActor::paint
* signal.</para></warning>
*
* Return value: a newly created Cairo context. Use cairo_destroy() * 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 * Since: 1.0
*/ */
@ -634,15 +638,19 @@ clutter_cairo_texture_create_region (ClutterCairoTexture *self,
/** /**
* clutter_cairo_texture_create: * clutter_cairo_texture_create:
* @cairo: a #ClutterCairoTexture * @self: a #ClutterCairoTexture
* *
* Creates a new Cairo context for the @cairo texture. It is * Creates a new Cairo context for the @cairo texture. It is
* similar to using clutter_cairo_texture_create_region() with @x_offset * 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 @y_offset of 0, @width equal to the @cairo texture surface width
* and @height equal to the @cairo texture surface height. * and @height equal to the @cairo texture surface height.
* *
* <warning><para>Do not call this function within the paint virtual
* function or from a callback to the #ClutterActor::paint
* signal.</para></warning>
*
* Return value: a newly created Cairo context. Use cairo_destroy() * 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 * 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 * @self: a #ClutterCairoTexture
* @width: the new width of the surface * @width: the new width of the surface
* @height: the new height of the surface * @height: the new height of the surface