From a37f537cd0a247e314d406c0352ffb947222e83d Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Tue, 24 Jul 2007 17:34:06 +0000 Subject: [PATCH] 2007-07-24 Emmanuele Bassi * clutter/clutter-actor.c: * clutter/clutter-box.h: * clutter/clutter-stage.c: Documentation fixes. --- ChangeLog | 6 ++++++ clutter/clutter-actor.c | 13 +++++++++++++ clutter/clutter-box.h | 10 ++++------ clutter/clutter-stage.c | 25 ++++++++++++++++--------- 4 files changed, 39 insertions(+), 15 deletions(-) diff --git a/ChangeLog b/ChangeLog index 504d19a01..f5ad0e4fb 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2007-07-24 Emmanuele Bassi + + * clutter/clutter-actor.c: + * clutter/clutter-box.h: + * clutter/clutter-stage.c: Documentation fixes. + 2007-07-24 Matthew Allum * clutter/cogl/gl/cogl-defines.h: diff --git a/clutter/clutter-actor.c b/clutter/clutter-actor.c index 739dc1e56..6b92ccfda 100644 --- a/clutter/clutter-actor.c +++ b/clutter/clutter-actor.c @@ -2152,11 +2152,16 @@ clutter_actor_rotate_yx (ClutterActor *self, * @self: A #ClutterActor * * Gets the angle of rotation around x axis in degrees. + * + * Returns: the angle or rotation, as a fixed point value + * + * Since: 0.4 */ ClutterFixed clutter_actor_get_rxangx (ClutterActor *self) { g_return_val_if_fail (CLUTTER_IS_ACTOR (self), 0); + return self->priv->rxang; } @@ -2165,6 +2170,10 @@ clutter_actor_get_rxangx (ClutterActor *self) * @self: A #ClutterActor * * Gets the angle of rotation around y axis in degrees. + * + * Return value: the angle of rotation, as a fixed point value + * + * Since: 0.4 */ ClutterFixed clutter_actor_get_ryangx (ClutterActor *self) @@ -2178,6 +2187,10 @@ clutter_actor_get_ryangx (ClutterActor *self) * @self: A #ClutterActor * * Gets the angle of rotation around x axis in degrees. + * + * Return value: the angle of rotation, as a fixed point value + * + * Since: 0.4 */ ClutterFixed clutter_actor_get_rzangx (ClutterActor *self) diff --git a/clutter/clutter-box.h b/clutter/clutter-box.h index 23b2c8e49..a2cff0ac6 100644 --- a/clutter/clutter-box.h +++ b/clutter/clutter-box.h @@ -14,12 +14,11 @@ G_BEGIN_DECLS /** * ClutterPackType: - * - * Pack order for a #ClutterBox child. - * * @CLUTTER_PACK_START: append child from the start * @CLUTTER_PACK_END: append child from the end * + * Pack order for a #ClutterBox child. + * * Since: 0.4 */ typedef enum { @@ -67,12 +66,11 @@ struct _ClutterBoxClass /** * ClutterBoxChild: - * - * Packing data for children of a #ClutterBox. - * * @actor: the child #ClutterActor * @pack_type: the type of packing used * + * Packing data for children of a #ClutterBox. + * * Since: 0.4 */ struct _ClutterBoxChild diff --git a/clutter/clutter-stage.c b/clutter/clutter-stage.c index 570164c70..ff7c3cdc4 100644 --- a/clutter/clutter-stage.c +++ b/clutter/clutter-stage.c @@ -562,16 +562,21 @@ clutter_stage_get_perspectivex (ClutterStage *stage, /** * clutter_stage_set_perspective * @stage: A #ClutterStage - * FIXME + * @fovy: FIXME + * @aspect: FIXME + * @z_near: FIXME + * @z_far: FIXME * * Set the stage perspective. - **/ + * + * Since: 0.4 + */ void -clutter_stage_set_perspective (ClutterStage *stage, - gfloat fovy, - gfloat aspect, - gfloat z_near, - gfloat z_far) +clutter_stage_set_perspective (ClutterStage *stage, + gfloat fovy, + gfloat aspect, + gfloat z_near, + gfloat z_far) { ClutterStagePrivate *priv; @@ -706,9 +711,11 @@ clutter_stage_show_cursor (ClutterStage *stage) /** * clutter_stage_hide_cursor: - * @stage: + * @stage: a #ClutterStage * - * Hides the cursor as invisible on the stage window + * Makes the cursor invisible on the stage window + * + * Since: 0.4 */ void clutter_stage_hide_cursor (ClutterStage *stage)