mirror of
https://github.com/brl/mutter.git
synced 2024-11-22 08:00:42 -05:00
introspection: Add missing (out) annotations
Comprehensively add (out) annotations to functions parameters returning int/float/double. Not handled here: structure out returns like ClutterColor or ClutterPerspective or GValue that should get (out caller-allocates). Not handled here: Cogl http://bugzilla.clutter-project.org/show_bug.cgi?id=2302
This commit is contained in:
parent
e4870ebaf4
commit
f1c44a27a1
@ -8764,7 +8764,7 @@ clutter_animatable_iface_init (ClutterAnimatableIface *iface)
|
||||
}
|
||||
|
||||
/**
|
||||
* clutter_actor_transform_stage_point
|
||||
* clutter_actor_transform_stage_point:
|
||||
* @self: A #ClutterActor
|
||||
* @x: (in): x screen coordinate of the point to unproject
|
||||
* @y: (in): y screen coordinate of the point to unproject
|
||||
|
@ -263,8 +263,8 @@ clutter_behaviour_depth_set_bounds (ClutterBehaviourDepth *behaviour,
|
||||
/**
|
||||
* clutter_behaviour_depth_get_bounds:
|
||||
* @behaviour: a #ClutterBehaviourDepth
|
||||
* @depth_start: return location for the initial depth value, or %NULL
|
||||
* @depth_end: return location for the final depth value, or %NULL
|
||||
* @depth_start: (out): return location for the initial depth value, or %NULL
|
||||
* @depth_end: (out): return location for the final depth value, or %NULL
|
||||
*
|
||||
* Gets the boundaries of the @behaviour
|
||||
*
|
||||
|
@ -629,8 +629,8 @@ clutter_behaviour_ellipse_set_center (ClutterBehaviourEllipse *self,
|
||||
/**
|
||||
* clutter_behaviour_ellipse_get_center:
|
||||
* @self: a #ClutterBehaviourEllipse
|
||||
* @x: return location for the X coordinate of the center, or %NULL
|
||||
* @y: return location for the Y coordinate of the center, or %NULL
|
||||
* @x: (out): return location for the X coordinate of the center, or %NULL
|
||||
* @y: (out): return location for the Y coordinate of the center, or %NULL
|
||||
*
|
||||
* Gets the center of the elliptical path path.
|
||||
*
|
||||
@ -979,9 +979,9 @@ clutter_behaviour_ellipse_set_tilt (ClutterBehaviourEllipse *self,
|
||||
/**
|
||||
* clutter_behaviour_ellipse_get_tilt:
|
||||
* @self: a #ClutterBehaviourEllipse
|
||||
* @angle_tilt_x: return location for tilt angle on the X axis, or %NULL.
|
||||
* @angle_tilt_y: return location for tilt angle on the Y axis, or %NULL.
|
||||
* @angle_tilt_z: return location for tilt angle on the Z axis, or %NULL.
|
||||
* @angle_tilt_x: (out): return location for tilt angle on the X axis, or %NULL.
|
||||
* @angle_tilt_y: (out): return location for tilt angle on the Y axis, or %NULL.
|
||||
* @angle_tilt_z: (out): return location for tilt angle on the Z axis, or %NULL.
|
||||
*
|
||||
* Gets the tilt of the ellipse around the center in Y axis.
|
||||
*
|
||||
|
@ -287,8 +287,8 @@ clutter_behaviour_opacity_set_bounds (ClutterBehaviourOpacity *behaviour,
|
||||
/**
|
||||
* clutter_behaviour_opacity_get_bounds:
|
||||
* @behaviour: a #ClutterBehaviourOpacity
|
||||
* @opacity_start: return location for the minimum level of opacity, or %NULL
|
||||
* @opacity_end: return location for the maximum level of opacity, or %NULL
|
||||
* @opacity_start: (out): return location for the minimum level of opacity, or %NULL
|
||||
* @opacity_end: (out): return location for the maximum level of opacity, or %NULL
|
||||
*
|
||||
* Gets the initial and final levels of the opacity applied by @behaviour
|
||||
* on each actor it controls.
|
||||
|
@ -655,9 +655,9 @@ clutter_behaviour_rotate_set_center (ClutterBehaviourRotate *rotate,
|
||||
/**
|
||||
* clutter_behaviour_rotate_get_center:
|
||||
* @rotate: a #ClutterBehaviourRotate
|
||||
* @x: return location for the X center of rotation
|
||||
* @y: return location for the Y center of rotation
|
||||
* @z: return location for the Z center of rotation
|
||||
* @x: (out): return location for the X center of rotation
|
||||
* @y: (out): return location for the Y center of rotation
|
||||
* @z: (out): return location for the Z center of rotation
|
||||
*
|
||||
* Retrieves the center of rotation set using
|
||||
* clutter_behaviour_rotate_set_center().
|
||||
|
@ -377,13 +377,13 @@ clutter_behaviour_scale_set_bounds (ClutterBehaviourScale *scale,
|
||||
/**
|
||||
* clutter_behaviour_scale_get_bounds:
|
||||
* @scale: a #ClutterBehaviourScale
|
||||
* @x_scale_start: return location for the initial scale factor on the X
|
||||
* @x_scale_start: (out): return location for the initial scale factor on the X
|
||||
* axis, or %NULL
|
||||
* @y_scale_start: return location for the initial scale factor on the Y
|
||||
* @y_scale_start: (out): return location for the initial scale factor on the Y
|
||||
* axis, or %NULL
|
||||
* @x_scale_end: return location for the final scale factor on the X axis,
|
||||
* @x_scale_end: (out): return location for the final scale factor on the X axis,
|
||||
* or %NULL
|
||||
* @y_scale_end: return location for the final scale factor on the Y axis,
|
||||
* @y_scale_end: (out): return location for the final scale factor on the Y axis,
|
||||
* or %NULL
|
||||
*
|
||||
* Retrieves the bounds used by scale behaviour.
|
||||
|
@ -732,8 +732,8 @@ clutter_cairo_texture_set_surface_size (ClutterCairoTexture *self,
|
||||
/**
|
||||
* clutter_cairo_texture_get_surface_size:
|
||||
* @self: a #ClutterCairoTexture
|
||||
* @width: return location for the surface width, or %NULL
|
||||
* @height: return location for the surface height, or %NULL
|
||||
* @width: (out): return location for the surface width, or %NULL
|
||||
* @height: (out): return location for the surface height, or %NULL
|
||||
*
|
||||
* Retrieves the surface width and height for @self.
|
||||
*
|
||||
|
@ -136,9 +136,9 @@ clutter_color_darken (const ClutterColor *color,
|
||||
/**
|
||||
* clutter_color_to_hls:
|
||||
* @color: a #ClutterColor
|
||||
* @hue: return location for the hue value or %NULL
|
||||
* @luminance: return location for the luminance value or %NULL
|
||||
* @saturation: return location for the saturation value or %NULL
|
||||
* @hue: (out): return location for the hue value or %NULL
|
||||
* @luminance: (out): return location for the luminance value or %NULL
|
||||
* @saturation: (out): return location for the saturation value or %NULL
|
||||
*
|
||||
* Converts @color to the HLS format.
|
||||
*
|
||||
|
@ -149,7 +149,7 @@ clutter_script_get_type_from_class (const gchar *name)
|
||||
* clutter_script_enum_from_string:
|
||||
* @type: a #GType for an enumeration type
|
||||
* @string: the enumeration value as a string
|
||||
* @enum_value: return location for the enumeration value as an integer
|
||||
* @enum_value: (out): return location for the enumeration value as an integer
|
||||
*
|
||||
* Converts an enumeration value inside @string into a numeric
|
||||
* value and places it into @enum_value.
|
||||
|
@ -746,9 +746,9 @@ clutter_text_coords_to_position (ClutterText *text,
|
||||
* clutter_text_position_to_coords:
|
||||
* @self: a #ClutterText
|
||||
* @position: position in characters
|
||||
* @x: return location for the X coordinate, or %NULL
|
||||
* @y: return location for the Y coordinate, or %NULL
|
||||
* @line_height: return location for the line height, or %NULL
|
||||
* @x: (out): return location for the X coordinate, or %NULL
|
||||
* @y: (out): return location for the Y coordinate, or %NULL
|
||||
* @line_height: (out): return location for the line height, or %NULL
|
||||
*
|
||||
* Retrieves the coordinates of the given @position.
|
||||
*
|
||||
|
Loading…
Reference in New Issue
Block a user