brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Fix argument syntax of existing commment blocks

Browse Source 
Fixes:
  Parsing comment block file : parameter expecter

by correctly declaring parameters.

(cherry picked from commit 2fe9bc2017fa966ab445674a530aac0c17204040)
This commit is contained in:
Damien Lespiau 2012-12-30 16:24:44 +00:00 committed by Robert Bragg
parent 5b7faf1134
commit 8c1708ec93
4 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
cogl/cogl-matrix.h
View File

@ -132,9 +132,9 @@ cogl_matrix_init_identity (CoglMatrix *matrix);
/**
* cogl_matrix_init_translation:
* @matrix: A 4x4 transformation matrix
* @tx x coordinate of the translation vector
* @ty y coordinate of the translation vector
* @tz z coordinate of the translation vector
* @tx: x coordinate of the translation vector
* @ty: y coordinate of the translation vector
* @tz: z coordinate of the translation vector
*
* Resets matrix to the (tx, ty, tz) translation matrix:
*

4
cogl/cogl-object.h
View File

@ -180,8 +180,8 @@ cogl_object_get_user_data (CoglObject *object,
/**
* cogl_debug_object_foreach_type:
* func: A callback function for each type
* user_data: A pointer to pass to @func
* @func: A callback function for each type
* @user_data: A pointer to pass to @func
*
* Invokes @func once for each type of object that Cogl uses and
* passes a count of the number of objects for that type. This is

2
cogl/cogl-renderer.h
View File

@ -239,7 +239,7 @@ cogl_renderer_check_onscreen_template (CoglRenderer *renderer,
/**
* cogl_renderer_connect:
* @renderer: An unconnected #CoglRenderer
* @error a pointer to a #CoglError for reporting exceptions
* @error: a pointer to a #CoglError for reporting exceptions
*
* Connects the configured @renderer. Renderer connection isn't a
* very active process, it basically just means validating that

18
cogl/cogl-texture.h
View File

@ -247,7 +247,7 @@ cogl_is_texture (void *object);
/**
* cogl_texture_get_width:
* @texture a #CoglTexture pointer.
* @texture: a #CoglTexture pointer.
*
* Queries the width of a cogl texture.
*
@ -258,7 +258,7 @@ cogl_texture_get_width (CoglTexture *texture);
/**
* cogl_texture_get_height:
* @texture a #CoglTexture pointer.
* @texture: a #CoglTexture pointer.
*
* Queries the height of a cogl texture.
*
@ -269,7 +269,7 @@ cogl_texture_get_height (CoglTexture *texture);
/**
* cogl_texture_get_format:
* @texture a #CoglTexture pointer.
* @texture: a #CoglTexture pointer.
*
* Queries the #CoglPixelFormat of a cogl texture.
*
@ -312,7 +312,7 @@ cogl_texture_get_rowstride (CoglTexture *texture);
/**
* cogl_texture_get_max_waste:
* @texture a #CoglTexture pointer.
* @texture: a #CoglTexture pointer.
*
* Queries the maximum wasted (unused) pixels in one dimension of a GPU side
* texture.
@ -324,7 +324,7 @@ cogl_texture_get_max_waste (CoglTexture *texture);
/**
* cogl_texture_is_sliced:
* @texture a #CoglTexture pointer.
* @texture: a #CoglTexture pointer.
*
* Queries if a texture is sliced (stored as multiple GPU side tecture
* objects).
@ -337,7 +337,7 @@ cogl_texture_is_sliced (CoglTexture *texture);
/**
* cogl_texture_get_gl_texture:
* @texture a #CoglTexture pointer.
* @texture: a #CoglTexture pointer.
* @out_gl_handle: (out) (allow-none): pointer to return location for the
* textures GL handle, or %NULL.
* @out_gl_target: (out) (allow-none): pointer to return location for the
@ -358,7 +358,7 @@ cogl_texture_get_gl_texture (CoglTexture *texture,
/**
* cogl_texture_get_data:
* @texture a #CoglTexture pointer.
* @texture: a #CoglTexture pointer.
* @format: the #CoglPixelFormat to store the texture as.
* @rowstride: the rowstride of @data in bytes or pass 0 to calculate
* from the bytes-per-pixel of @format multiplied by the
@ -383,7 +383,7 @@ cogl_texture_get_data (CoglTexture *texture,
/**
* cogl_texture_set_region:
* @texture a #CoglTexture.
* @texture: a #CoglTexture.
* @src_x: upper left coordinate to use from source data.
* @src_y: upper left coordinate to use from source data.
* @dst_x: upper left destination horizontal coordinate.
@ -425,7 +425,7 @@ cogl_texture_set_region (CoglTexture *texture,
/**
* cogl_texture_set_region_from_bitmap:
* @texture a #CoglTexture pointer
* @texture: a #CoglTexture pointer
* @src_x: upper left coordinate to use from the source bitmap.
* @src_y: upper left coordinate to use from the source bitmap
* @dst_x: upper left destination horizontal coordinate.