From 742cc4d95b602440c004d5af09a7fab662f03596 Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Mon, 7 Sep 2009 11:44:44 +0100 Subject: [PATCH] [docs] Small annotation fixes --- clutter/clutter-behaviour.c | 5 +++-- clutter/cogl/cogl-material.h | 29 ++++++++++++++++++----------- clutter/cogl/cogl-texture.h | 7 ++++--- 3 files changed, 25 insertions(+), 16 deletions(-) diff --git a/clutter/clutter-behaviour.c b/clutter/clutter-behaviour.c index 99156a7f6..42e2a9cd9 100644 --- a/clutter/clutter-behaviour.c +++ b/clutter/clutter-behaviour.c @@ -616,8 +616,9 @@ clutter_behaviour_set_alpha (ClutterBehaviour *behave, * for derived classes to use this in there alpha notify method but use * #clutter_behaviour_actors_foreach as it avoids alot of needless allocations. * - * Return value: (transfer container) (element-type ClutterActor): a list of actors. - * You should free the returned list with g_slist_free() when finished using it. + * Return value: (transfer container) (element-type ClutterActor): a list of + * actors. You should free the returned list with g_slist_free() when + * finished using it. * * Since: 0.2 */ diff --git a/clutter/cogl/cogl-material.h b/clutter/cogl/cogl-material.h index 3223817fb..5a708ee46 100644 --- a/clutter/cogl/cogl-material.h +++ b/clutter/cogl/cogl-material.h @@ -147,7 +147,8 @@ gboolean cogl_is_material (CoglHandle handle); * * Since 1.0 */ -void cogl_material_set_color (CoglHandle material, const CoglColor *color); +void cogl_material_set_color (CoglHandle material, + const CoglColor *color); /** * cogl_material_set_color4ub: @@ -198,7 +199,8 @@ void cogl_material_set_color4f (CoglHandle material, * * Since 1.0 */ -void cogl_material_get_color (CoglHandle material, CoglColor *color); +void cogl_material_get_color (CoglHandle material, + CoglColor *color); /** * cogl_material_set_ambient: @@ -227,7 +229,8 @@ void cogl_material_set_ambient (CoglHandle material, * * Since 1.0 */ -void cogl_material_get_ambient (CoglHandle material, CoglColor *ambient); +void cogl_material_get_ambient (CoglHandle material, + CoglColor *ambient); /** * cogl_material_set_diffuse: @@ -255,7 +258,8 @@ void cogl_material_set_diffuse (CoglHandle material, * * Since 1.0 */ -void cogl_material_get_diffuse (CoglHandle material, CoglColor *diffuse); +void cogl_material_get_diffuse (CoglHandle material, + CoglColor *diffuse); /** * cogl_material_set_ambient_and_diffuse: @@ -299,7 +303,8 @@ void cogl_material_set_specular (CoglHandle material, * * Since 1.0 */ -void cogl_material_get_specular (CoglHandle material, CoglColor *specular); +void cogl_material_get_specular (CoglHandle material, + CoglColor *specular); /** * cogl_material_set_shininess: @@ -353,7 +358,8 @@ void cogl_material_set_emission (CoglHandle material, * * Since 1.0 */ -void cogl_material_get_emission (CoglHandle material, CoglColor *emission); +void cogl_material_get_emission (CoglHandle material, + CoglColor *emission); /** * CoglMaterialAlphaFunc: @@ -505,8 +511,8 @@ gboolean cogl_material_set_blend (CoglHandle material, * * Since: 1.0 */ -void cogl_material_set_blend_constant (CoglHandle material, - CoglColor *constant_color); +void cogl_material_set_blend_constant (CoglHandle material, + CoglColor *constant_color); /** * cogl_material_set_layer: @@ -671,9 +677,10 @@ void cogl_material_set_layer_matrix (CoglHandle material, * This function lets you access a materials internal list of layers * for iteration. * - * Returns: A list of #CoglHandle's that can be passed to the - * cogl_material_layer_* functions. The list is owned by COGL and it - * should not be modified or freed + * Returns: (element-type Handle) (transfer none): A list of + * #CoglHandle's that can be passed to the cogl_material_layer_* + * functions. The list is owned by COGL and it should not be modified or + * freed */ G_CONST_RETURN GList *cogl_material_get_layers (CoglHandle material); diff --git a/clutter/cogl/cogl-texture.h b/clutter/cogl/cogl-texture.h index e3a2264a1..ab80805d7 100644 --- a/clutter/cogl/cogl-texture.h +++ b/clutter/cogl/cogl-texture.h @@ -245,9 +245,10 @@ gboolean cogl_texture_is_sliced (CoglHandle handle); /** * cogl_texture_get_gl_texture: * @handle: a #CoglHandle for a texture. - * @out_gl_handle: pointer to return location for the textures GL handle, or - * NULL. - * @out_gl_target: pointer to return location for the GL target type, or NULL. + * @out_gl_handle: (out) (allow-none): pointer to return location for the + * textures GL handle, or %NULL. + * @out_gl_target: (out) (allow-none): pointer to return location for the + * GL target type, or %NULL. * * Query the GL handles for a GPU side texture through it's #CoglHandle, * if the texture is spliced the data for the first sub texture will be