From 3fe5d68011595face613a1166c8c1f60a0d1e16f Mon Sep 17 00:00:00 2001 From: Rico Tzschichholz Date: Mon, 11 Apr 2016 11:55:55 +0200 Subject: [PATCH] Add some missing argument (out) annotations https://bugzilla.gnome.org/show_bug.cgi?id=764883 --- atk/atkcomponent.c | 16 ++++++++-------- atk/atkimage.c | 8 ++++---- atk/atktext.c | 10 +++++----- atk/atkvalue.c | 10 +++++----- 4 files changed, 22 insertions(+), 22 deletions(-) diff --git a/atk/atkcomponent.c b/atk/atkcomponent.c index c89e471..53c1e7e 100644 --- a/atk/atkcomponent.c +++ b/atk/atkcomponent.c @@ -249,10 +249,10 @@ atk_component_ref_accessible_at_point (AtkComponent *component, /** * atk_component_get_extents: * @component: an #AtkComponent - * @x: address of #gint to put x coordinate - * @y: address of #gint to put y coordinate - * @width: address of #gint to put width - * @height: address of #gint to put height + * @x: (out) (optional): address of #gint to put x coordinate + * @y: (out) (optional): address of #gint to put y coordinate + * @width: (out) (optional): address of #gint to put width + * @height: (out) (optional): address of #gint to put height * @coord_type: specifies whether the coordinates are relative to the screen * or to the components top level window * @@ -299,8 +299,8 @@ atk_component_get_extents (AtkComponent *component, /** * atk_component_get_position: * @component: an #AtkComponent - * @x: address of #gint to put x coordinate position - * @y: address of #gint to put y coordinate position + * @x: (out) (optional): address of #gint to put x coordinate position + * @y: (out) (optional): address of #gint to put y coordinate position * @coord_type: specifies whether the coordinates are relative to the screen * or to the components top level window * @@ -339,8 +339,8 @@ atk_component_get_position (AtkComponent *component, /** * atk_component_get_size: * @component: an #AtkComponent - * @width: address of #gint to put width of @component - * @height: address of #gint to put height of @component + * @width: (out) (optional): address of #gint to put width of @component + * @height: (out) (optional): address of #gint to put height of @component * * Gets the size of the @component in terms of width and height. * diff --git a/atk/atkimage.c b/atk/atkimage.c index 2ba5909..3a00886 100644 --- a/atk/atkimage.c +++ b/atk/atkimage.c @@ -91,8 +91,8 @@ atk_image_get_image_description (AtkImage *image) /** * atk_image_get_image_size: * @image: a #GObject instance that implements AtkImageIface - * @width: filled with the image width, or -1 if the value cannot be obtained. - * @height: filled with the image height, or -1 if the value cannot be obtained. + * @width: (out) (optional): filled with the image width, or -1 if the value cannot be obtained. + * @height: (out) (optional): filled with the image height, or -1 if the value cannot be obtained. * * Get the width and height in pixels for the specified image. * The values of @width and @height are returned as -1 if the @@ -164,8 +164,8 @@ atk_image_set_image_description (AtkImage *image, /** * atk_image_get_image_position: * @image: a #GObject instance that implements AtkImageIface - * @x: address of #gint to put x coordinate position; otherwise, -1 if value cannot be obtained. - * @y: address of #gint to put y coordinate position; otherwise, -1 if value cannot be obtained. + * @x: (out) (optional): address of #gint to put x coordinate position; otherwise, -1 if value cannot be obtained. + * @y: (out) (optional): address of #gint to put y coordinate position; otherwise, -1 if value cannot be obtained. * @coord_type: specifies whether the coordinates are relative to the screen * or to the components top level window * diff --git a/atk/atktext.c b/atk/atktext.c index f18e8cb..5244015 100644 --- a/atk/atktext.c +++ b/atk/atktext.c @@ -653,10 +653,10 @@ atk_text_get_caret_offset (AtkText *text) * atk_text_get_character_extents: * @text: an #AtkText * @offset: The offset of the text character for which bounding information is required. - * @x: Pointer for the x cordinate of the bounding box - * @y: Pointer for the y cordinate of the bounding box - * @width: Pointer for the width of the bounding box - * @height: Pointer for the height of the bounding box + * @x: (out) (optional): Pointer for the x cordinate of the bounding box + * @y: (out) (optional): Pointer for the y cordinate of the bounding box + * @width: (out) (optional): Pointer for the width of the bounding box + * @height: (out) (optional): Pointer for the height of the bounding box * @coords: specify whether coordinates are relative to the screen or widget window * * Get the bounding box containing the glyph representing the character at @@ -1053,7 +1053,7 @@ atk_text_set_caret_offset (AtkText *text, * @end_offset: The offset of the text character after the last character * for which boundary information is required. * @coord_type: Specify whether coordinates are relative to the screen or widget window. - * @rect: A pointer to a AtkTextRectangle which is filled in by this function. + * @rect: (out): A pointer to a AtkTextRectangle which is filled in by this function. * * Get the bounding box for text within the specified range. * diff --git a/atk/atkvalue.c b/atk/atkvalue.c index adabeb8..d52d754 100644 --- a/atk/atkvalue.c +++ b/atk/atkvalue.c @@ -363,7 +363,7 @@ atk_value_base_init (AtkValueIface *class) /** * atk_value_get_current_value: * @obj: a GObject instance that implements AtkValueIface - * @value: a #GValue representing the current accessible value + * @value: (out): a #GValue representing the current accessible value * * Gets the value of this object. * @@ -395,7 +395,7 @@ atk_value_get_current_value (AtkValue *obj, /** * atk_value_get_maximum_value: * @obj: a GObject instance that implements AtkValueIface - * @value: a #GValue representing the maximum accessible value + * @value: (out): a #GValue representing the maximum accessible value * * Gets the maximum value of this object. * @@ -426,7 +426,7 @@ atk_value_get_maximum_value (AtkValue *obj, /** * atk_value_get_minimum_value: * @obj: a GObject instance that implements AtkValueIface - * @value: a #GValue representing the minimum accessible value + * @value: (out): a #GValue representing the minimum accessible value * * Gets the minimum value of this object. * @@ -457,7 +457,7 @@ atk_value_get_minimum_value (AtkValue *obj, /** * atk_value_get_minimum_increment: * @obj: a GObject instance that implements AtkValueIface - * @value: a #GValue representing the minimum increment by which the accessible value may be changed + * @value: (out): a #GValue representing the minimum increment by which the accessible value may be changed * * Gets the minimum increment by which the value of this object may be changed. If zero, * the minimum increment is undefined, which may mean that it is limited only by the @@ -707,7 +707,7 @@ initialize_value_type_names () /** * atk_value_type_get_name: - * @role: The #AtkValueType whose name is required + * @value_type: The #AtkValueType whose name is required * * Gets the description string describing the #AtkValueType @value_type. * -- 2.7.4