diff --git a/ChangeLog b/ChangeLog index 178edcfd5..76f9adef8 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,10 @@ +2007-12-24 Emmanuele Bassi + + * clutter/clutter-stage.c: + * clutter/clutter-stage.h: + * clutter/clutter-texture.c: Remove some of the remaining FIXMEs + in the API documentation + 2007-12-24 Emmanuele Bassi * clutter/clutter-color.c: diff --git a/clutter/clutter-stage.c b/clutter/clutter-stage.c index d74cc0b3a..a1644da6d 100644 --- a/clutter/clutter-stage.c +++ b/clutter/clutter-stage.c @@ -568,10 +568,13 @@ clutter_stage_get_perspectivex (ClutterStage *stage, /** * clutter_stage_set_perspective * @stage: A #ClutterStage - * @fovy: FIXME - * @aspect: FIXME - * @z_near: FIXME - * @z_far: FIXME + * @fovy: the field of view angle, in degrees, in the y direction + * @aspect: the aspect ratio that determines the field of view in the x + * direction. The aspect ratio is the ratio of x (width) to y (height) + * @z_near: the distance from the viewer to the near clipping + * plane (always positive) + * @z_far: the distance from the viewer to the far clipping + * plane (always positive) * * Set the stage perspective. * @@ -601,12 +604,16 @@ clutter_stage_set_perspective (ClutterStage *stage, /** * clutter_stage_get_perspective * @stage: A #ClutterStage - * @fovy: FIXME - * @aspect: FIXME - * @z_near: FIXME - * @z_far: FIXME + * @fovy: return location for the field of view, in degrees, or %NULL + * @aspect: return location for the aspect ratio, or %NULL + * @z_near: return location for the distance of the viewer from the + * near clipping plane, or %NULL + * @z_far: return location for the distance of the viewer from the + * far clipping plane, or %NULL * * Retrieves the stage perspective. + * + * Since: 0.4 */ void clutter_stage_get_perspective (ClutterStage *stage, diff --git a/clutter/clutter-stage.h b/clutter/clutter-stage.h index 491bdb23f..efd9b4c62 100644 --- a/clutter/clutter-stage.h +++ b/clutter/clutter-stage.h @@ -116,12 +116,16 @@ struct _ClutterStageClass /** * ClutterPerspective: - * @fovy: FIXME - * @aspect: FIXME - * @z_near: FIXME - * @z_far: FIXME + * @fovy: the field of view angle, in degrees, in the y direction + * @aspect: the aspect ratio that determines the field of view in the x + * direction. The aspect ratio is the ratio of x (width) to y (height) + * @z_near: the distance from the viewer to the near clipping + * plane (always positive) + * @z_far: the distance from the viewer to the far clipping + * plane (always positive) * - * Stage perspective definition. + * Stage perspective definition. #ClutterPerspective is only used by + * the fixed point version of clutter_stage_set_perspective(). * * Since: 0.4 */ @@ -136,11 +140,13 @@ struct _ClutterPerspective /** * ClutterFog: * @density: density of the fog - * @z_near: start point of the depth cueing - * @z_far: end point of the depth cueing + * @z_near: starting distance from the viewer to the near clipping + * plane (always positive) + * @z_far: final distance from the viewer to the far clipping + * plane (always positive) * - * Fog settings used to create the depth cueing effect. This - * structure is useful only when using the fixed point API. + * Fog settings used to create the depth cueing effect. #ClutterFox is + * useful only when using the fixed point API. * * Since: 0.6 */ diff --git a/clutter/clutter-texture.c b/clutter/clutter-texture.c index 31aea7c1b..37c43b3ea 100644 --- a/clutter/clutter-texture.c +++ b/clutter/clutter-texture.c @@ -1330,13 +1330,15 @@ texture_prepare_upload (gboolean initialize, * @rowstride: Distance in bytes between row starts. * @bpp: bytes per pixel ( Currently only 4 supported ) * @flags: #ClutterTextureFlags - * @error: FIXME. + * @error: return location for a #GError, or %NULL. * * Sets #ClutterTexture image data. * - * Return value: TRUE on success, FALSE on failure. + * Note: This function is likely to change in future versions. * - * Since 0.4. This function is likely to change in future versions. + * Return value: %TRUE on success, %FALSE on failure. + * + * Since: 0.4. **/ gboolean clutter_texture_set_from_rgb_data (ClutterTexture *texture, @@ -2020,14 +2022,14 @@ texture_update_data (ClutterTexture *texture, * @rowstride: Distance in bytes between row starts. * @bpp: bytes per pixel ( Currently only 4 supported ) * @flags: #ClutterTextureFlags - * @error: FIXME. + * @error: return location for a #GError, or %NULL * * Updates a subregion of the pixel data in a #ClutterTexture. * - * Return value: TRUE on success, FALSE on failure. + * Return value: %TRUE on success, %FALSE on failure. * * Since 0.6. - **/ + */ gboolean clutter_texture_set_area_from_rgb_data (ClutterTexture *texture, const guchar *data,