[cogl] Fix some doc issues
- From: Neil Roberts <nroberts src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [cogl] Fix some doc issues
- Date: Tue, 14 Feb 2012 20:47:15 +0000 (UTC)
commit e98f27971239cfba8f5539372b95e92ecdc6c7af
Author: Jasper St. Pierre <jstpierre mecheye net>
Date: Mon Feb 13 10:19:05 2012 -0500
Fix some doc issues
Reviewed-by: Neil Roberts <neil linux intel com>
cogl/cogl-buffer.h | 2 +-
cogl/cogl-framebuffer.h | 6 +++---
cogl/cogl-material-compat.h | 4 ++--
cogl/cogl-matrix.h | 2 +-
cogl/cogl-meta-texture.h | 4 ++--
cogl/cogl-quaternion.h | 6 +++---
6 files changed, 12 insertions(+), 12 deletions(-)
---
diff --git a/cogl/cogl-buffer.h b/cogl/cogl-buffer.h
index 4c4576f..c1fceca 100644
--- a/cogl/cogl-buffer.h
+++ b/cogl/cogl-buffer.h
@@ -65,7 +65,7 @@ typedef struct _CoglBuffer CoglBuffer;
/**
* cogl_is_buffer:
- * @buffer: a buffer object
+ * @object: a buffer object
*
* Checks whether @buffer is a buffer object.
*
diff --git a/cogl/cogl-framebuffer.h b/cogl/cogl-framebuffer.h
index 5579ad1..f57334b 100644
--- a/cogl/cogl-framebuffer.h
+++ b/cogl/cogl-framebuffer.h
@@ -386,7 +386,7 @@ cogl_framebuffer_set_modelview_matrix (CoglFramebuffer *framebuffer,
/**
* cogl_framebuffer_perspective:
* @framebuffer: A #CoglFramebuffer pointer
- * @fovy: Vertical field of view angle in degrees.
+ * @fov_y: Vertical field of view angle in degrees.
* @aspect: The (width over height) aspect ratio for display
* @z_near: The distance to the near clipping plane (Must be positive,
* and must not be 0)
@@ -484,7 +484,7 @@ cogl_framebuffer_get_projection_matrix (CoglFramebuffer *framebuffer,
CoglMatrix *matrix);
/**
- * cogl_set_projection_matrix:
+ * cogl_framebuffer_set_projection_matrix:
* @framebuffer: A #CoglFramebuffer pointer
* @matrix: the new projection matrix
*
@@ -770,7 +770,7 @@ cogl_framebuffer_get_color_format (CoglFramebuffer *framebuffer);
/**
* cogl_framebuffer_set_samples_per_pixel:
* @framebuffer: A #CoglFramebuffer framebuffer
- * @n: The minimum number of samples per pixel
+ * @samples_per_pixel: The minimum number of samples per pixel
*
* Requires that when rendering to @framebuffer then @n point samples
* should be made per pixel which will all contribute to the final
diff --git a/cogl/cogl-material-compat.h b/cogl/cogl-material-compat.h
index 2e347d5..ecd1908 100644
--- a/cogl/cogl-material-compat.h
+++ b/cogl/cogl-material-compat.h
@@ -1221,9 +1221,9 @@ cogl_material_set_depth_state (CoglMaterial *material,
GError **error);
/**
- * cogl_material_get_depth_state
+ * cogl_material_get_depth_state:
* @material: A #CoglMaterial object
- * @state: A destination #CoglDepthState struct
+ * @state_out: A destination #CoglDepthState struct
*
* Retrieves the current depth state configuration for the given
* @pipeline as previously set using cogl_pipeline_set_depth_state().
diff --git a/cogl/cogl-matrix.h b/cogl/cogl-matrix.h
index ddc4feb..cca1823 100644
--- a/cogl/cogl-matrix.h
+++ b/cogl/cogl-matrix.h
@@ -276,7 +276,7 @@ cogl_matrix_frustum (CoglMatrix *matrix,
/**
* cogl_matrix_perspective:
* @matrix: A 4x4 transformation matrix
- * @fovy: Vertical field of view angle in degrees.
+ * @fov_y: Vertical field of view angle in degrees.
* @aspect: The (width over height) aspect ratio for display
* @z_near: The distance to the near clipping plane (Must be positive,
* and must not be 0)
diff --git a/cogl/cogl-meta-texture.h b/cogl/cogl-meta-texture.h
index 3c82f4f..dca9f5e 100644
--- a/cogl/cogl-meta-texture.h
+++ b/cogl/cogl-meta-texture.h
@@ -129,8 +129,8 @@ typedef void (*CoglMetaTextureCallback) (CoglTexture *sub_texture,
* @ty_1: The top-left y coordinate of the region to iterate
* @tx_2: The bottom-right x coordinate of the region to iterate
* @ty_2: The bottom-right y coordinate of the region to iterate
- * @wrap_x: The wrap mode for the x-axis
- * @wrap_y: The wrap mode for the y-axis
+ * @wrap_s: The wrap mode for the x-axis
+ * @wrap_t: The wrap mode for the y-axis
* @callback: A #CoglMetaTextureCallback pointer to be called
* for each low-level texture within the specified region.
* @user_data: A private pointer that is passed to @callback.
diff --git a/cogl/cogl-quaternion.h b/cogl/cogl-quaternion.h
index 02512f8..874a461 100644
--- a/cogl/cogl-quaternion.h
+++ b/cogl/cogl-quaternion.h
@@ -164,7 +164,7 @@ cogl_quaternion_init (CoglQuaternion *quaternion,
/**
* cogl_quaternion_init_from_angle_vector:
* @quaternion: An uninitialized #CoglQuaternion
- * @axis: your 3 component axis vector about which you want to rotate.
+ * @axis3f: your 3 component axis vector about which you want to rotate.
*
* Initializes a quaternion that rotates @angle degrees around the
* given @axis vector. The axis vector does not need to be
@@ -330,8 +330,8 @@ cogl_quaternion_normalize (CoglQuaternion *quaternion);
/**
* cogl_quaternion_dot_product:
- * @quaternion: A #CoglQuaternion
- *
+ * @a: A #CoglQuaternion
+ * @b: A #CoglQuaternion
*
* Since: 2.0
*/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]