procyberian/gimp
2
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/gimp.git synced 2025-07-03 17:33:25 +00:00
Code Issues 1 Projects 1 Releases Packages Wiki Activity Actions

gir: Add more (out) annotations

Browse source 
This will change the API for some bindings, so we probably want to do it
before a release.
This commit is contained in:
Niels De Graef 2020-05-03 17:57:23 +02:00
parent 8d1ad63f3a
commit db0493aa0d
6 changed files with 21 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

4
app/core/gimpsymmetry.c
View file

@ -401,9 +401,9 @@ gimp_symmetry_get_coords (GimpSymmetry *sym,
* gimp_symmetry_get_transform:
* @sym: the #GimpSymmetry
* @stroke: the stroke number
* @angle: output pointer to the transformation rotation angle,
* @angle: (out): output pointer to the transformation rotation angle,
* in degrees (ccw)
* @reflect: output pointer to the transformation reflection flag
* @reflect: (out): output pointer to the transformation reflection flag
*
* Returns: the transformation to apply to the paint content for stroke
* number @stroke. The transformation is comprised of rotation, possibly

6
libgimp/gimpzoompreview.c
View file

@ -874,11 +874,11 @@ gimp_zoom_preview_get_factor (GimpZoomPreview *preview)
/**
* gimp_zoom_preview_get_source:
* @preview: a #GimpZoomPreview widget
* @width: a pointer to an int where the current width of the zoom widget
* @width: (out): a pointer to an int where the current width of the zoom widget
* will be put.
* @height: a pointer to an int where the current width of the zoom widget
* @height: (out): a pointer to an int where the current width of the zoom widget
* will be put.
* @bpp: return location for the number of bytes per pixel
* @bpp: (out): return location for the number of bytes per pixel
*
* Returns the scaled image data of the part of the drawable the
* #GimpZoomPreview is currently showing, as a newly allocated array of guchar.

6
libgimpbase/gimpmetadata.c
View file

@ -1200,9 +1200,9 @@ gimp_metadata_set_bits_per_sample (GimpMetadata *metadata,
/**
* gimp_metadata_get_resolution:
* @metadata: A #GimpMetadata instance.
* @xres: Return location for the X Resolution, in ppi
* @yres: Return location for the Y Resolution, in ppi
* @unit: Return location for the unit unit
* @xres: (out) (optional): Return location for the X Resolution, in ppi
* @yres: (out) (optional): Return location for the Y Resolution, in ppi
* @unit: (out) (optional): Return location for the unit unit
*
* Returns values based on Exif.Image.XResolution,
* Exif.Image.YResolution and Exif.Image.ResolutionUnit of @metadata.

8
libgimpwidgets/gimppreview.c
View file

@ -656,8 +656,8 @@ gimp_preview_set_size (GimpPreview *preview,
/**
* gimp_preview_get_size:
* @preview: a #GimpPreview widget
* @width: return location for the preview area width
* @height: return location for the preview area height
* @width: (out) (optional): return location for the preview area width
* @height: (out) (optional): return location for the preview area height
*
* Since: 2.2
**/
@ -709,8 +709,8 @@ gimp_preview_get_offsets (GimpPreview *preview,
/**
* gimp_preview_get_position:
* @preview: a #GimpPreview widget
* @x: return location for the horizontal offset
* @y: return location for the vertical offset
* @x: (out) (optional): return location for the horizontal offset
* @y: (out) (optional): return location for the vertical offset
*
* Since: 2.2
**/

11
libgimpwidgets/gimpruler.c
View file

@ -756,10 +756,13 @@ gimp_ruler_set_range (GimpRuler *ruler,
/**
* gimp_ruler_get_range:
* @ruler: a #GimpRuler
* @lower: location to store lower limit of the ruler, or %NULL
* @upper: location to store upper limit of the ruler, or %NULL
* @max_size: location to store the maximum size of the ruler used when
* calculating the space to leave for the text, or %NULL.
* @lower: (out) (optional): location to store lower limit of the ruler,
* or %NULL
* @upper: (out) (optional): location to store upper limit of the ruler,
* or %NULL
* @max_size: (out) (optional): location to store the maximum size of the ruler
* used when calculating the space to leave for
* the text, or %NULL.
*
* Retrieves values indicating the range and current position of a #GimpRuler.
* See gimp_ruler_set_range().

4
libgimpwidgets/gimpzoommodel.c
View file

@ -404,8 +404,8 @@ gimp_zoom_model_get_factor (GimpZoomModel *model)
/**
* gimp_zoom_model_get_fraction
* @model: a #GimpZoomModel
* @numerator: return location for numerator
* @denominator: return location for denominator
* @numerator: (out): return location for numerator
* @denominator: (out): return location for denominator
*
* Retrieves the current zoom factor of @model as a fraction.
*