GNOME.org
 

[gdk-pixbuf] Add introspection annotations

commit 71e968d2c10db1494c46908ead37ece96b2bbd38
Author: Johan Dahlin <johan gnome org>
Date:   Sat Sep 18 13:03:14 2010 -0300

    Add introspection annotations

 gdk-pixbuf/gdk-pixbuf-animation.c |   10 +++++-----
 gdk-pixbuf/gdk-pixbuf-data.c      |    4 ++--
 gdk-pixbuf/gdk-pixbuf-io.c        |   17 +++++++++--------
 gdk-pixbuf/gdk-pixbuf-loader.c    |    4 ++--
 gdk-pixbuf/gdk-pixbuf-scale.c     |    8 ++++----
 gdk-pixbuf/gdk-pixbuf-util.c      |    4 ++--
 gdk-pixbuf/gdk-pixbuf.c           |    8 ++++----
 gdk-pixbuf/gdk-pixdata.c          |    2 +-
 8 files changed, 29 insertions(+), 28 deletions(-)
---
diff --git a/gdk-pixbuf/gdk-pixbuf-animation.c b/gdk-pixbuf/gdk-pixbuf-animation.c
index 272a763..efb9b3d 100644
--- a/gdk-pixbuf/gdk-pixbuf-animation.c
+++ b/gdk-pixbuf/gdk-pixbuf-animation.c
@@ -255,7 +255,7 @@ gdk_pixbuf_animation_new_from_file (const char *filename,
 #endif
 
 /**
- * gdk_pixbuf_animation_ref:
+ * gdk_pixbuf_animation_ref: (skip)
  * @animation: An animation.
  *
  * Adds a reference to an animation.
@@ -271,7 +271,7 @@ gdk_pixbuf_animation_ref (GdkPixbufAnimation *animation)
 }
 
 /**
- * gdk_pixbuf_animation_unref:
+ * gdk_pixbuf_animation_unref: (skip)
  * @animation: An animation.
  *
  * Removes a reference from an animation.
@@ -314,7 +314,7 @@ gdk_pixbuf_animation_is_static_image (GdkPixbufAnimation *animation)
  * sophisticated. If an animation hasn't loaded any frames yet, this
  * function will return %NULL.
  * 
- * Return value: unanimated image representing the animation
+ * Return value: (transfer none): unanimated image representing the animation
  **/
 GdkPixbuf*
 gdk_pixbuf_animation_get_static_image (GdkPixbufAnimation *animation)
@@ -410,7 +410,7 @@ gdk_pixbuf_animation_get_height (GdkPixbufAnimation *animation)
  *
  * A delay time of -1 is possible, indicating "infinite."
  * 
- * Return value: an iterator to move over the animation
+ * Return value: (transfer full): an iterator to move over the animation
  **/
 GdkPixbufAnimationIter*
 gdk_pixbuf_animation_get_iter (GdkPixbufAnimation *animation,
@@ -477,7 +477,7 @@ gdk_pixbuf_animation_iter_get_delay_time (GdkPixbufAnimationIter *iter)
  * (don't just add a reference), as it may get recycled as you advance
  * the iterator.
  *
- * Return value: the pixbuf to be displayed
+ * Return value: (transfer none): the pixbuf to be displayed
  **/
 GdkPixbuf*
 gdk_pixbuf_animation_iter_get_pixbuf (GdkPixbufAnimationIter *iter)
diff --git a/gdk-pixbuf/gdk-pixbuf-data.c b/gdk-pixbuf/gdk-pixbuf-data.c
index 87af0b9..5f4ce8e 100644
--- a/gdk-pixbuf/gdk-pixbuf-data.c
+++ b/gdk-pixbuf/gdk-pixbuf-data.c
@@ -37,14 +37,14 @@
  * @width: Width of the image in pixels, must be > 0
  * @height: Height of the image in pixels, must be > 0
  * @rowstride: Distance in bytes between row starts
- * @destroy_fn: Function used to free the data when the pixbuf's reference count
+ * @destroy_fn: (scope async): Function used to free the data when the pixbuf's reference count
  * drops to zero, or %NULL if the data should not be freed
  * @destroy_fn_data: Closure data to pass to the destroy notification function
  * 
  * Creates a new #GdkPixbuf out of in-memory image data.  Currently only RGB
  * images with 8 bits per sample are supported.
  * 
- * Return value: A newly-created #GdkPixbuf structure with a reference count of 1.
+ * Return value: (transfer full): A newly-created #GdkPixbuf structure with a reference count of 1.
  **/
 GdkPixbuf *
 gdk_pixbuf_new_from_data (const guchar *data, GdkColorspace colorspace, gboolean has_alpha,
diff --git a/gdk-pixbuf/gdk-pixbuf-io.c b/gdk-pixbuf/gdk-pixbuf-io.c
index e8ce72d..aa4964f 100644
--- a/gdk-pixbuf/gdk-pixbuf-io.c
+++ b/gdk-pixbuf/gdk-pixbuf-io.c
@@ -2110,7 +2110,7 @@ gdk_pixbuf_savev (GdkPixbuf  *pixbuf,
 /**
  * gdk_pixbuf_save_to_callback:
  * @pixbuf: a #GdkPixbuf.
- * @save_func: a function that is called to save each block of data that
+ * @save_func: (scope call): a function that is called to save each block of data that
  *   the save routine generates.
  * @user_data: user data to pass to the save function.
  * @type: name of file format.
@@ -2164,7 +2164,7 @@ gdk_pixbuf_save_to_callback    (GdkPixbuf  *pixbuf,
 /**
  * gdk_pixbuf_save_to_callbackv:
  * @pixbuf: a #GdkPixbuf.
- * @save_func: a function that is called to save each block of data that
+ * @save_func: (scope call): a function that is called to save each block of data that
  *   the save routine generates.
  * @user_data: user data to pass to the save function.
  * @type: name of file format.
@@ -2502,7 +2502,7 @@ gdk_pixbuf_format_get_description (GdkPixbufFormat *format)
  *
  * Returns the mime types supported by the format.
  * 
- * Return value: a %NULL-terminated array of mime types which must be freed with 
+ * Return value: (transfer full): a %NULL-terminated array of mime types which must be freed with 
  * g_strfreev() when it is no longer needed.
  *
  * Since: 2.2
@@ -2522,7 +2522,7 @@ gdk_pixbuf_format_get_mime_types (GdkPixbufFormat *format)
  * Returns the filename extensions typically used for files in the 
  * given format.
  * 
- * Return value: a %NULL-terminated array of filename extensions which must be
+ * Return value: (transfer full): a %NULL-terminated array of filename extensions which must be
  * freed with g_strfreev() when it is no longer needed.
  *
  * Since: 2.2
@@ -2649,10 +2649,11 @@ _gdk_pixbuf_get_format (GdkPixbufModule *module)
  * Obtains the available information about the image formats supported
  * by GdkPixbuf.
  *
- * Returns: A list of #GdkPixbufFormat<!-- -->s describing the supported 
- * image formats.  The list should be freed when it is no longer needed, 
- * but the structures themselves are owned by #GdkPixbuf and should not be 
- * freed.  
+ * Returns: (transfer container): (element-type GdkPixbufFormat): A list of
+ * #GdkPixbufFormat<!-- -->s describing the supported
+ * image formats.  The list should be freed when it is no longer needed,
+ * but the structures themselves are owned by #GdkPixbuf and should not be
+ * freed.
  *
  * Since: 2.2
  */
diff --git a/gdk-pixbuf/gdk-pixbuf-loader.c b/gdk-pixbuf/gdk-pixbuf-loader.c
index 720ef80..97d73b1 100644
--- a/gdk-pixbuf/gdk-pixbuf-loader.c
+++ b/gdk-pixbuf/gdk-pixbuf-loader.c
@@ -625,7 +625,7 @@ gdk_pixbuf_loader_new_with_mime_type (const char *mime_type,
  * return the "static image" of the animation
  * (see gdk_pixbuf_animation_get_static_image()).
  * 
- * Return value: The #GdkPixbuf that the loader is creating, or %NULL if not
+ * Return value: (transfer none): The #GdkPixbuf that the loader is creating, or %NULL if not
  * enough data has been read to determine how to create the image buffer.
  **/
 GdkPixbuf *
@@ -653,7 +653,7 @@ gdk_pixbuf_loader_get_pixbuf (GdkPixbufLoader *loader)
  * bytes yet (hasn't emitted the "area-prepared" signal) this function will 
  * return %NULL.
  *
- * Return value: The #GdkPixbufAnimation that the loader is loading, or %NULL if
+ * Return value: (transfer none): The #GdkPixbufAnimation that the loader is loading, or %NULL if
  not enough data has been read to determine the information.
 **/
 GdkPixbufAnimation *
diff --git a/gdk-pixbuf/gdk-pixbuf-scale.c b/gdk-pixbuf/gdk-pixbuf-scale.c
index 6039845..bf08018 100644
--- a/gdk-pixbuf/gdk-pixbuf-scale.c
+++ b/gdk-pixbuf/gdk-pixbuf-scale.c
@@ -236,7 +236,7 @@ gdk_pixbuf_composite_color (const GdkPixbuf *src,
  * For more complicated scaling/compositing see gdk_pixbuf_scale()
  * and gdk_pixbuf_composite().
  * 
- * Return value: the new #GdkPixbuf, or %NULL if not enough memory could be
+ * Return value: (transfer full): the new #GdkPixbuf, or %NULL if not enough memory could be
  * allocated for it.
  **/
 GdkPixbuf *
@@ -278,7 +278,7 @@ gdk_pixbuf_scale_simple (const GdkPixbuf *src,
  * @dest_height and compositing the result with a checkboard of colors
  * @color1 and @color2.
  * 
- * Return value: the new #GdkPixbuf, or %NULL if not enough memory could be
+ * Return value: (transfer full): the new #GdkPixbuf, or %NULL if not enough memory could be
  * allocated for it.
  **/
 GdkPixbuf *
@@ -320,7 +320,7 @@ gdk_pixbuf_composite_color_simple (const GdkPixbuf *src,
  * Rotates a pixbuf by a multiple of 90 degrees, and returns the
  * result in a new pixbuf.
  *
- * Returns: the new #GdkPixbuf, or %NULL if not enough memory could be
+ * Returns: (transfer full): the new #GdkPixbuf, or %NULL if not enough memory could be
  * allocated for it.
  *
  * Since: 2.6
@@ -413,7 +413,7 @@ gdk_pixbuf_rotate_simple (const GdkPixbuf   *src,
  * Flips a pixbuf horizontally or vertically and returns the
  * result in a new pixbuf.
  *
- * Returns: the new #GdkPixbuf, or %NULL if not enough memory could be
+ * Returns: (transfer full): the new #GdkPixbuf, or %NULL if not enough memory could be
  * allocated for it.
  *
  * Since: 2.6
diff --git a/gdk-pixbuf/gdk-pixbuf-util.c b/gdk-pixbuf/gdk-pixbuf-util.c
index 4b29669..fcac31f 100644
--- a/gdk-pixbuf/gdk-pixbuf-util.c
+++ b/gdk-pixbuf/gdk-pixbuf-util.c
@@ -48,7 +48,7 @@
  * assigned zero opacity. That is, if you pass (255, 255, 255) for the
  * substitute color, all white pixels will become fully transparent.
  *
- * Return value: A newly-created pixbuf with a reference count of 1.
+ * Return value: (transfer full): A newly-created pixbuf with a reference count of 1.
  **/
 GdkPixbuf *
 gdk_pixbuf_add_alpha (const GdkPixbuf *pixbuf,
@@ -266,7 +266,7 @@ gdk_pixbuf_saturate_and_pixelate(const GdkPixbuf *src,
  * appropriate transform will be performed so that the pixbuf
  * is oriented correctly.
  *
- * Return value: A newly-created pixbuf, or a reference to the
+ * Return value: (transfer full): A newly-created pixbuf, or a reference to the
  * input pixbuf (with an increased reference count).
  *
  * Since: 2.12
diff --git a/gdk-pixbuf/gdk-pixbuf.c b/gdk-pixbuf/gdk-pixbuf.c
index 824e290..77fe6e6 100644
--- a/gdk-pixbuf/gdk-pixbuf.c
+++ b/gdk-pixbuf/gdk-pixbuf.c
@@ -187,7 +187,7 @@ gdk_pixbuf_finalize (GObject *object)
 
 
 /**
- * gdk_pixbuf_ref:
+ * gdk_pixbuf_ref: (skip)
  * @pixbuf: A pixbuf.
  *
  * Adds a reference to a pixbuf.
@@ -203,7 +203,7 @@ gdk_pixbuf_ref (GdkPixbuf *pixbuf)
 }
 
 /**
- * gdk_pixbuf_unref:
+ * gdk_pixbuf_unref: (skip)
  * @pixbuf: A pixbuf.
  *
  * Removes a reference from a pixbuf.
@@ -285,7 +285,7 @@ gdk_pixbuf_new (GdkColorspace colorspace,
  * Creates a new #GdkPixbuf with a copy of the information in the specified
  * @pixbuf.
  * 
- * Return value: A newly-created pixbuf with a reference count of 1, or %NULL if
+ * Return value: (transfer full): A newly-created pixbuf with a reference count of 1, or %NULL if
  * not enough memory could be allocated.
  **/
 GdkPixbuf *
@@ -334,7 +334,7 @@ gdk_pixbuf_copy (const GdkPixbuf *pixbuf)
  * @src_pixbuf will not be finalized until the new pixbuf
  * is finalized.
  * 
- * Return value: a new pixbuf 
+ * Return value: (transfer full): a new pixbuf 
  **/
 GdkPixbuf*
 gdk_pixbuf_new_subpixbuf (GdkPixbuf *src_pixbuf,
diff --git a/gdk-pixbuf/gdk-pixdata.c b/gdk-pixbuf/gdk-pixdata.c
index 4db8514..2147950 100644
--- a/gdk-pixbuf/gdk-pixdata.c
+++ b/gdk-pixbuf/gdk-pixdata.c
@@ -297,7 +297,7 @@ free_buffer (guchar *pixels, gpointer data)
 }
 
 /**
- * gdk_pixdata_from_pixbuf:
+ * gdk_pixdata_from_pixbuf: (skip)
  * @pixdata: a #GdkPixdata to fill.
  * @pixbuf: the data to fill @pixdata with.
  * @use_rle: whether to use run-length encoding for the pixel data.
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]