Add some more introspection annotations

This commit is contained in:
Emmanuele Bassi 2010-09-06 16:11:46 +01:00
parent 070e239b6d
commit b4120b81e4
5 changed files with 14 additions and 11 deletions

View File

@ -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

View File

@ -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
*/

View File

@ -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.</note>
*
* 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);

View File

@ -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;

View File

@ -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);