[Cogl] [PATCH 13/53] doc: Fix argument syntax of existing commment blocks

Damien Lespiau damien.lespiau at gmail.com
Tue Jan 1 06:30:49 PST 2013


From: Damien Lespiau <damien.lespiau at intel.com>

Fixes:
  Parsing comment block file : parameter expecter

by correctly declaring parameters.
---
 cogl/cogl-matrix.h   |    6 +++---
 cogl/cogl-object.h   |    4 ++--
 cogl/cogl-renderer.h |    2 +-
 cogl/cogl-texture.h  |   18 +++++++++---------
 4 files changed, 15 insertions(+), 15 deletions(-)

diff --git a/cogl/cogl-matrix.h b/cogl/cogl-matrix.h
index 05cab4f..48da1e8 100644
--- a/cogl/cogl-matrix.h
+++ b/cogl/cogl-matrix.h
@@ -124,9 +124,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:
  *
diff --git a/cogl/cogl-object.h b/cogl/cogl-object.h
index a0e099e..7797656 100644
--- a/cogl/cogl-object.h
+++ b/cogl/cogl-object.h
@@ -178,8 +178,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
diff --git a/cogl/cogl-renderer.h b/cogl/cogl-renderer.h
index 4596519..14e2a63 100644
--- a/cogl/cogl-renderer.h
+++ b/cogl/cogl-renderer.h
@@ -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
diff --git a/cogl/cogl-texture.h b/cogl/cogl-texture.h
index 0b5475f..a8d3fea 100644
--- a/cogl/cogl-texture.h
+++ b/cogl/cogl-texture.h
@@ -262,7 +262,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.
  *
@@ -273,7 +273,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.
  *
@@ -284,7 +284,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.
  *
@@ -295,7 +295,7 @@ cogl_texture_get_format (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.
@@ -307,7 +307,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).
@@ -320,7 +320,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
@@ -341,7 +341,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
@@ -400,7 +400,7 @@ cogl_texture_draw_and_read_to_bitmap (CoglTexture *texture,
 
 /**
  * cogl_texture_set_region:
- * @texture a #CoglTexture.
+ * @texture: a #CoglTexture.
  * @width: width of the region to set.
  * @height: height of the region to set.
  * @format: the #CoglPixelFormat used in the source @data buffer.
@@ -485,7 +485,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 x coordinate of the region in the source bitmap.
  * @src_y: upper left y coordinate of the region in the source bitmap
  * @width: width of the region to copy. (Must be less than or equal to
-- 
1.7.7.5



More information about the Cogl mailing list