From b4120b81e4a472fff5f7388b4cfc8f717ecc23f0 Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Mon, 6 Sep 2010 16:11:46 +0100 Subject: [PATCH] Add some more introspection annotations --- clutter/clutter-main.c | 6 +++--- clutter/clutter-offscreen-effect.c | 4 +++- clutter/cogl/cogl/cogl-material.h | 2 +- clutter/cogl/cogl/cogl-offscreen.h | 11 ++++++----- clutter/cogl/cogl/cogl-types.h | 2 +- 5 files changed, 14 insertions(+), 11 deletions(-) diff --git a/clutter/clutter-main.c b/clutter/clutter-main.c index 3c8718cff..2ad7a9d9a 100644 --- a/clutter/clutter-main.c +++ b/clutter/clutter-main.c @@ -1055,7 +1055,7 @@ clutter_threads_init (void) } /** - * clutter_threads_set_lock_functions: + * clutter_threads_set_lock_functions: (skip) * @enter_fn: function called when aquiring the Clutter main lock * @leave_fn: function called when releasing the Clutter main lock * @@ -1854,7 +1854,7 @@ post_parse_hook (GOptionContext *context, } /** - * clutter_get_option_group: + * clutter_get_option_group: (skip) * * Returns a #GOptionGroup for the command line arguments recognized * by Clutter. You should add this group to your #GOptionContext with @@ -1911,7 +1911,7 @@ clutter_get_option_group (void) } /** - * clutter_get_option_group_without_init: + * clutter_get_option_group_without_init: (skip) * * Returns a #GOptionGroup for the command line arguments recognized * by Clutter. You should add this group to your #GOptionContext with diff --git a/clutter/clutter-offscreen-effect.c b/clutter/clutter-offscreen-effect.c index 2685afe7a..d60d83ff0 100644 --- a/clutter/clutter-offscreen-effect.c +++ b/clutter/clutter-offscreen-effect.c @@ -469,7 +469,9 @@ clutter_offscreen_effect_paint_target (ClutterOffscreenEffect *effect) * * Calls the create_texture() virtual function of the @effect * - * Return value: a handle to a Cogl texture, or %COGL_INVALID_HANDLE + * Return value: (transfer full): a handle to a Cogl texture, or + * %COGL_INVALID_HANDLE. The returned handle has its reference + * count increased. * * Since: 1.4 */ diff --git a/clutter/cogl/cogl/cogl-material.h b/clutter/cogl/cogl/cogl-material.h index ef5b76a9b..11ce4e54c 100644 --- a/clutter/cogl/cogl/cogl-material.h +++ b/clutter/cogl/cogl/cogl-material.h @@ -945,7 +945,7 @@ cogl_material_layer_get_type (CoglMaterialLayer *layer); * should call cogl_material_layer_get_type() first in order check it is of * type %COGL_MATERIAL_LAYER_TYPE_TEXTURE before calling this function. * - * Return value: a #CoglHandle for the texture inside the layer + * Return value: (transfer none): a #CoglHandle for the texture inside the layer */ CoglHandle cogl_material_layer_get_texture (CoglMaterialLayer *layer); diff --git a/clutter/cogl/cogl/cogl-offscreen.h b/clutter/cogl/cogl/cogl-offscreen.h index 6cfba881b..c70eb999d 100644 --- a/clutter/cogl/cogl/cogl-offscreen.h +++ b/clutter/cogl/cogl/cogl-offscreen.h @@ -55,8 +55,9 @@ G_BEGIN_DECLS * * Note: This does not work with sliced Cogl textures. * - * Returns: a #CoglHandle for the new offscreen buffer or %COGL_INVALID_HANDLE - * if it wasn't possible to create the buffer. + * Return value: (transfer full): a #CoglHandle for the new offscreen + * buffer or %COGL_INVALID_HANDLE if it wasn't possible to create the + * buffer. */ CoglHandle cogl_offscreen_new_to_texture (CoglHandle handle); @@ -80,9 +81,9 @@ gboolean cogl_is_offscreen (CoglHandle handle); * * Increments the reference count on the offscreen buffer. * - * Returns: For convenience it returns the given CoglHandle + * Return value: (transfer none): For convenience it returns the given CoglHandle * - * Deprecated: 1.2: cogl_handle_ref should be used in new code. + * Deprecated: 1.2: cogl_handle_ref() should be used in new code. */ CoglHandle cogl_offscreen_ref (CoglHandle handle) G_GNUC_DEPRECATED; @@ -93,7 +94,7 @@ CoglHandle cogl_offscreen_ref (CoglHandle handle) G_GNU * Decreases the reference count for the offscreen buffer and frees it when * the count reaches 0. * - * Deprecated: 1.2: cogl_handle_unref should be used in new code. + * Deprecated: 1.2: cogl_handle_unref() should be used in new code. */ void cogl_offscreen_unref (CoglHandle handle) G_GNUC_DEPRECATED; diff --git a/clutter/cogl/cogl/cogl-types.h b/clutter/cogl/cogl/cogl-types.h index 0e654acda..fef08ae38 100644 --- a/clutter/cogl/cogl/cogl-types.h +++ b/clutter/cogl/cogl/cogl-types.h @@ -68,7 +68,7 @@ cogl_handle_get_type (void) G_GNUC_CONST; * * Increases the reference count of @handle by 1 * - * Returns: the handle, with its reference count increased + * Return value: (transfer none): the handle, with its reference count increased */ CoglHandle cogl_handle_ref (CoglHandle handle);