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

Add (out) annotations for ClutterActor

Browse Source 
Add missing (out) annotations to the doc comments for ClutterActor methods
with multiple return values.

Fix the definition of clutter_actor_get_allocation_vertices() to be
consistent with the declaration and have verts[4] rather than verts[].x

http://bugzilla.openedhand.com/show_bug.cgi?id=1481
This commit is contained in:
Owen W. Taylor 2009-02-26 14:42:19 -05:00 committed by Emmanuele Bassi
parent 75e5b805ab
commit 02b2b664d8
1 changed files with 46 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
clutter/clutter-actor.c
View File

@ -1226,7 +1226,7 @@ clutter_actor_transform_and_project_box (ClutterActor *self,
* @self: A #ClutterActor
* @ancestor: A #ClutterActor to calculate the vertices against, or %NULL
* to use the default #ClutterStage
* @verts: return location for an array of 4 #ClutterVertex in which
* @verts: (out) (array): return location for an array of 4 #ClutterVertex in which
* to store the result.
*
* Calculates the transformed coordinates of the four corners of the
@ -1249,7 +1249,7 @@ clutter_actor_transform_and_project_box (ClutterActor *self,
void
clutter_actor_get_allocation_vertices (ClutterActor *self,
ClutterActor *ancestor,
ClutterVertex verts[])
ClutterVertex verts[4])
{
ClutterActorPrivate *priv;
ClutterActor *stage;
@ -3389,8 +3389,8 @@ clutter_actor_get_preferred_size (ClutterActor *self,
* @self: A #ClutterActor
* @for_height: available height when computing the preferred width,
* or a negative value to indicate that no height is defined
* @min_width_p: return location for minimum width, or %NULL
* @natural_width_p: return location for the natural width, or %NULL
* @min_width_p: (out): return location for minimum width, or %NULL
* @natural_width_p: (out): return location for the natural width, or %NULL
*
* Computes the requested minimum and natural widths for an actor,
* optionally depending on the specified height, or if they are
@ -3461,8 +3461,8 @@ clutter_actor_get_preferred_width (ClutterActor *self,
* @self: A #ClutterActor
* @for_width: available width to assume in computing desired height,
* or a negative value to indicate that no width is defined
* @min_height_p: return location for minimum height, or %NULL
* @natural_height_p: return location for natural height, or %NULL
* @min_height_p: (out): return location for minimum height, or %NULL
* @natural_height_p: (out): return location for natural height, or %NULL
*
* Computes the requested minimum and natural heights for an actor,
* or if they are already computed, returns the cached values.
@ -3530,10 +3530,10 @@ clutter_actor_get_preferred_height (ClutterActor *self,
/**
* clutter_actor_get_allocation_coords:
* @self: A #ClutterActor
* @x_1: x1 coordinate
* @y_1: y1 coordinate
* @x_2: x2 coordinate
* @y_2: y2 coordinate
* @x_1: (out): x1 coordinate
* @y_1: (out): y1 coordinate
* @x_2: (out): x2 coordinate
* @y_2: (out): y2 coordinate
*
* Gets the layout box an actor has been assigned. The allocation can
* only be assumed valid inside a paint() method; anywhere else, it
@ -3575,7 +3575,7 @@ clutter_actor_get_allocation_coords (ClutterActor *self,
/**
* clutter_actor_get_allocation_box:
* @self: A #ClutterActor
* @box: the function fills this in with the actor's allocation
* @box: (out): the function fills this in with the actor's allocation
*
* Gets the layout box an actor has been assigned. The allocation can
* only be assumed valid inside a paint() method; anywhere else, it
@ -3627,7 +3627,7 @@ clutter_actor_get_allocation_box (ClutterActor *self,
/**
* clutter_actor_get_allocation_geometry:
* @self: A #ClutterActor
* @geom: allocation geometry in pixels
* @geom: (out): allocation geometry in pixels
*
* Gets the layout box an actor has been assigned. The allocation can
* only be assumed valid inside a paint() method; anywhere else, it
@ -3744,7 +3744,7 @@ clutter_actor_set_geometry (ClutterActor *self,
/**
* clutter_actor_get_geometry:
* @self: A #ClutterActor
* @geometry: A location to store actors #ClutterGeometry
* @geometry: (out): A location to store actors #ClutterGeometry
*
* Gets the size and position of an actor relative to its parent
* actor. This is the same as calling clutter_actor_get_position() and
@ -4322,8 +4322,8 @@ clutter_actor_get_position (ClutterActor *self,
/**
* clutter_actor_get_positionu:
* @self: a #ClutterActor
* @x: return location for the X coordinate, or %NULL
* @y: return location for the Y coordinate, or %NULL
* @x: (out): return location for the X coordinate, or %NULL
* @y: (out): return location for the Y coordinate, or %NULL
*
* This function tries to "do what you mean" and tell you where the
* actor is, prior to any transformations. Retrieves the fixed
@ -4379,8 +4379,8 @@ clutter_actor_get_transformed_positionu (ClutterActor *self,
/**
* clutter_actor_get_transformed_position
* @self: A #ClutterActor
* @x: return location for the X coordinate, or %NULL
* @y: return location for the Y coordinate, or %NULL
* @x: (out): return location for the X coordinate, or %NULL
* @y: (out): return location for the Y coordinate, or %NULL
*
* Gets the absolute position of an actor, in pixels, relative
* to the stage.
@ -4408,8 +4408,8 @@ clutter_actor_get_transformed_position (ClutterActor *self,
/**
* clutter_actor_get_transformed_sizeu:
* @self: A #ClutterActor
* @width: return location for the width, or %NULL
* @height: return location for the height, or %NULL
* @width: (out): return location for the width, or %NULL
* @height: (out): return location for the height, or %NULL
*
* Gets the absolute size of an actor in #ClutterUnits<!-- -->s, taking
* into account the scaling factors.
@ -4499,8 +4499,8 @@ clutter_actor_get_transformed_sizeu (ClutterActor *self,
/**
* clutter_actor_get_transformed_size:
* @self: A #ClutterActor
* @width: return location for the width, or %NULL
* @height: return location for the height, or %NULL
* @width: (out): return location for the width, or %NULL
* @height: (out): return location for the height, or %NULL
*
* Gets the absolute size of an actor taking into account
* any scaling factors
@ -5202,8 +5202,8 @@ clutter_actor_set_scale_with_gravity (ClutterActor *self,
/**
* clutter_actor_get_scale:
* @self: A #ClutterActor
* @scale_x: Location to store horizonal float scale factor, or %NULL.
* @scale_y: Location to store vertical float scale factor, or %NULL.
* @scale_x: (out): Location to store horizonal float scale factor, or %NULL.
* @scale_y: (out): Location to store vertical float scale factor, or %NULL.
*
* Retrieves an actors scale in floating point.
*
@ -5226,8 +5226,8 @@ clutter_actor_get_scale (ClutterActor *self,
/**
* clutter_actor_get_scale_center:
* @self: A #ClutterActor
* @center_x: Location to store the X position of the scale center, or %NULL.
* @center_y: Location to store the Y position of the scale center, or %NULL.
* @center_x: (out): Location to store the X position of the scale center, or %NULL.
* @center_y: (out): Location to store the Y position of the scale center, or %NULL.
*
* Retrieves the scale center coordinate in pixels relative to the top
* left corner of the actor. If the scale center was specified using a
@ -5256,8 +5256,8 @@ clutter_actor_get_scale_center (ClutterActor *self,
/**
* clutter_actor_get_scale_centeru:
* @self: A #ClutterActor
* @center_x: Location to store the X position of the scale center, or %NULL.
* @center_y: Location to store the Y position of the scale center, or %NULL.
* @center_x: (out): Location to store the X position of the scale center, or %NULL.
* @center_y: (out): Location to store the Y position of the scale center, or %NULL.
*
* ClutterUnit<!-- -->s version of clutter_actor_get_scale_center().
*
@ -5669,11 +5669,11 @@ clutter_actor_set_z_rotation_from_gravity (ClutterActor *self,
* clutter_actor_get_rotationu:
* @self: a #ClutterActor
* @axis: the axis of rotation
* @x: return value for the X coordinate of the center of rotation,
* @x: (out): return value for the X coordinate of the center of rotation,
* in #ClutterUnit<!-- -->s
* @y: return value for the Y coordinate of the center of rotation,
* @y: (out): return value for the Y coordinate of the center of rotation,
* in #ClutterUnit<!-- -->s
* @z: return value for the Z coordinate of the center of rotation,
* @z: (out): return value for the Z coordinate of the center of rotation,
* in #ClutterUnit<!-- -->s
*
* Retrieves the angle and center of rotation on the given axis,
@ -5727,9 +5727,9 @@ clutter_actor_get_rotationu (ClutterActor *self,
* clutter_actor_get_rotation:
* @self: a #ClutterActor
* @axis: the axis of rotation
* @x: return value for the X coordinate of the center of rotation
* @y: return value for the Y coordinate of the center of rotation
* @z: return value for the Z coordinate of the center of rotation
* @x: (out): return value for the X coordinate of the center of rotation
* @y: (out): return value for the Y coordinate of the center of rotation
* @z: (out): return value for the Z coordinate of the center of rotation
*
* Retrieves the angle and center of rotation on the given axis,
* set using clutter_actor_set_angle().
@ -5906,10 +5906,10 @@ clutter_actor_has_clip (ClutterActor *self)
/**
* clutter_actor_get_clipu:
* @self: a #ClutterActor
* @xoff: return location for the X offset of the clip rectangle, or %NULL
* @yoff: return location for the Y offset of the clip rectangle, or %NULL
* @width: return location for the width of the clip rectangle, or %NULL
* @height: return location for the height of the clip rectangle, or %NULL
* @xoff: (out): return location for the X offset of the clip rectangle, or %NULL
* @yoff: (out): return location for the Y offset of the clip rectangle, or %NULL
* @width: (out): return location for the width of the clip rectangle, or %NULL
* @height: (out): return location for the height of the clip rectangle, or %NULL
*
* Unit-based variant of clutter_actor_get_clip().
*
@ -5949,10 +5949,10 @@ clutter_actor_get_clipu (ClutterActor *self,
/**
* clutter_actor_get_clip:
* @self: a #ClutterActor
* @xoff: return location for the X offset of the clip rectangle, or %NULL
* @yoff: return location for the Y offset of the clip rectangle, or %NULL
* @width: return location for the width of the clip rectangle, or %NULL
* @height: return location for the height of the clip rectangle, or %NULL
* @xoff: (out): return location for the X offset of the clip rectangle, or %NULL
* @yoff: (out): return location for the Y offset of the clip rectangle, or %NULL
* @width: (out): return location for the width of the clip rectangle, or %NULL
* @height: (out): return location for the height of the clip rectangle, or %NULL
*
* Gets the clip area for @self, in pixels.
*
@ -6546,8 +6546,8 @@ clutter_actor_move_anchor_point (ClutterActor *self,
/**
* clutter_actor_get_anchor_point:
* @self: a #ClutterActor
* @anchor_x: return location for the X coordinate of the anchor point
* @anchor_y: return location for the Y coordinate of the anchor point
* @anchor_x: (out): return location for the X coordinate of the anchor point
* @anchor_y: (out): return location for the Y coordinate of the anchor point
*
* Gets the current anchor point of the @actor in pixels.
*
@ -6693,8 +6693,8 @@ clutter_actor_move_anchor_pointu (ClutterActor *self,
/**
* clutter_actor_get_anchor_pointu:
* @self: a #ClutterActor
* @anchor_x: return location for the X coordinate of the anchor point
* @anchor_y: return location for the Y coordinate of the anchor point
* @anchor_x: (out): return location for the X coordinate of the anchor point
* @anchor_y: (out): return location for the Y coordinate of the anchor point
*
* Gets the current anchor point of the @actor in #ClutterUnit<!-- -->s.
*
@ -7823,7 +7823,7 @@ clutter_actor_is_scaled (ClutterActor *self)
/**
* clutter_actor_box_get_from_vertices:
* @vtx: array of four #ClutterVertex
* @box: return location for a #ClutterActorBox
* @box: (out): return location for a #ClutterActorBox
*
* Calculates the bounding box represented by the four vertices; for details
* of the vertex array see clutter_actor_get_abs_allocation_vertices().