isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-11-25 17:40:40 -05:00
Code Issues Packages Projects Releases Wiki Activity

introspection: Add missing (out) annotations

Browse Source 
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:
Owen W. Taylor 2010-09-08 10:37:58 -04:00 committed by Emmanuele Bassi
parent e4870ebaf4
commit f1c44a27a1
10 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
clutter/clutter-actor.c
View File

@ -8764,7 +8764,7 @@ clutter_animatable_iface_init (ClutterAnimatableIface *iface)
} }
/** /**
* clutter_actor_transform_stage_point * clutter_actor_transform_stage_point:
* @self: A #ClutterActor * @self: A #ClutterActor
* @x: (in): x screen coordinate of the point to unproject * @x: (in): x screen coordinate of the point to unproject
* @y: (in): y screen coordinate of the point to unproject * @y: (in): y screen coordinate of the point to unproject

4
clutter/clutter-behaviour-depth.c
View File

@ -263,8 +263,8 @@ clutter_behaviour_depth_set_bounds (ClutterBehaviourDepth *behaviour,
/** /**
* clutter_behaviour_depth_get_bounds: * clutter_behaviour_depth_get_bounds:
* @behaviour: a #ClutterBehaviourDepth * @behaviour: a #ClutterBehaviourDepth
* @depth_start: return location for the initial depth value, or %NULL * @depth_start: (out): return location for the initial depth value, or %NULL
* @depth_end: return location for the final depth value, or %NULL * @depth_end: (out): return location for the final depth value, or %NULL
* *
* Gets the boundaries of the @behaviour * Gets the boundaries of the @behaviour
* *

10
clutter/clutter-behaviour-ellipse.c
View File

@ -629,8 +629,8 @@ clutter_behaviour_ellipse_set_center (ClutterBehaviourEllipse *self,
/** /**
* clutter_behaviour_ellipse_get_center: * clutter_behaviour_ellipse_get_center:
* @self: a #ClutterBehaviourEllipse * @self: a #ClutterBehaviourEllipse
* @x: return location for the X coordinate of the center, or %NULL * @x: (out): return location for the X coordinate of the center, or %NULL
* @y: return location for the Y 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. * Gets the center of the elliptical path path.
* *
@ -979,9 +979,9 @@ clutter_behaviour_ellipse_set_tilt (ClutterBehaviourEllipse *self,
/** /**
* clutter_behaviour_ellipse_get_tilt: * clutter_behaviour_ellipse_get_tilt:
* @self: a #ClutterBehaviourEllipse * @self: a #ClutterBehaviourEllipse
* @angle_tilt_x: return location for tilt angle on the X axis, or %NULL. * @angle_tilt_x: (out): 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_y: (out): 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_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. * Gets the tilt of the ellipse around the center in Y axis.
* *

4
clutter/clutter-behaviour-opacity.c
View File

@ -287,8 +287,8 @@ clutter_behaviour_opacity_set_bounds (ClutterBehaviourOpacity *behaviour,
/** /**
* clutter_behaviour_opacity_get_bounds: * clutter_behaviour_opacity_get_bounds:
* @behaviour: a #ClutterBehaviourOpacity * @behaviour: a #ClutterBehaviourOpacity
* @opacity_start: return location for the minimum level of opacity, or %NULL * @opacity_start: (out): return location for the minimum level of opacity, or %NULL
* @opacity_end: return location for the maximum 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 * Gets the initial and final levels of the opacity applied by @behaviour
* on each actor it controls. * on each actor it controls.

6
clutter/clutter-behaviour-rotate.c
View File

@ -655,9 +655,9 @@ clutter_behaviour_rotate_set_center (ClutterBehaviourRotate *rotate,
/** /**
* clutter_behaviour_rotate_get_center: * clutter_behaviour_rotate_get_center:
* @rotate: a #ClutterBehaviourRotate * @rotate: a #ClutterBehaviourRotate
* @x: return location for the X center of rotation * @x: (out): return location for the X center of rotation
* @y: return location for the Y center of rotation * @y: (out): return location for the Y center of rotation
* @z: return location for the Z center of rotation * @z: (out): return location for the Z center of rotation
* *
* Retrieves the center of rotation set using * Retrieves the center of rotation set using
* clutter_behaviour_rotate_set_center(). * clutter_behaviour_rotate_set_center().

8
clutter/clutter-behaviour-scale.c
View File

@ -377,13 +377,13 @@ clutter_behaviour_scale_set_bounds (ClutterBehaviourScale *scale,
/** /**
* clutter_behaviour_scale_get_bounds: * clutter_behaviour_scale_get_bounds:
* @scale: a #ClutterBehaviourScale * @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 * 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 * 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 * 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 * or %NULL
* *
* Retrieves the bounds used by scale behaviour. * Retrieves the bounds used by scale behaviour.

4
clutter/clutter-cairo-texture.c
View File

@ -732,8 +732,8 @@ clutter_cairo_texture_set_surface_size (ClutterCairoTexture *self,
/** /**
* clutter_cairo_texture_get_surface_size: * clutter_cairo_texture_get_surface_size:
* @self: a #ClutterCairoTexture * @self: a #ClutterCairoTexture
* @width: return location for the surface width, or %NULL * @width: (out): return location for the surface width, or %NULL
* @height: return location for the surface height, or %NULL * @height: (out): return location for the surface height, or %NULL
* *
* Retrieves the surface width and height for @self. * Retrieves the surface width and height for @self.
* *

6
clutter/clutter-color.c
View File

@ -136,9 +136,9 @@ clutter_color_darken (const ClutterColor *color,
/** /**
* clutter_color_to_hls: * clutter_color_to_hls:
* @color: a #ClutterColor * @color: a #ClutterColor
* @hue: return location for the hue value or %NULL * @hue: (out): return location for the hue value or %NULL
* @luminance: return location for the luminance value or %NULL * @luminance: (out): return location for the luminance value or %NULL
* @saturation: return location for the saturation value or %NULL * @saturation: (out): return location for the saturation value or %NULL
* *
* Converts @color to the HLS format. * Converts @color to the HLS format.
* *

2
clutter/clutter-script-parser.c
View File

@ -149,7 +149,7 @@ clutter_script_get_type_from_class (const gchar *name)
* clutter_script_enum_from_string: * clutter_script_enum_from_string:
* @type: a #GType for an enumeration type * @type: a #GType for an enumeration type
* @string: the enumeration value as a string * @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 * Converts an enumeration value inside @string into a numeric
* value and places it into @enum_value. * value and places it into @enum_value.

6
clutter/clutter-text.c
View File

@ -746,9 +746,9 @@ clutter_text_coords_to_position (ClutterText *text,
* clutter_text_position_to_coords: * clutter_text_position_to_coords:
* @self: a #ClutterText * @self: a #ClutterText
* @position: position in characters * @position: position in characters
* @x: return location for the X coordinate, or %NULL * @x: (out): return location for the X coordinate, or %NULL
* @y: return location for the Y coordinate, or %NULL * @y: (out): return location for the Y coordinate, or %NULL
* @line_height: return location for the line height, or %NULL * @line_height: (out): return location for the line height, or %NULL
* *
* Retrieves the coordinates of the given @position. * Retrieves the coordinates of the given @position.
* *