Reduce the amount of warnings coming from g-ir-scanner.
*
* See also clutter_actor_get_pango_context().
*
- * Return value: the newly created #PangoContext. Use g_object_unref()
- * on the returned value to deallocate its resources
+ * Return value: (transfer full): the newly created #PangoContext.
+ * Use g_object_unref() on the returned value to deallocate its
+ * resources
*
* Since: 1.0
*/
* and #ClutterBackend::resolution-changed signals, and call
* pango_layout_context_changed() in response to them.
*
- * Return value: the newly created #PangoLayout. Use g_object_unref()
- * when done
+ * Return value: (transfer full): the newly created #PangoLayout.
+ * Use g_object_unref() when done
*
* Since: 1.0
*/
}
/**
- * clutter_alpha_register_func:
+ * clutter_alpha_register_func: (skip):
* @func: a #ClutterAlphaFunc
* @data: user data to pass to @func, or %NULL
*
*
* The logical id is always greater than %CLUTTER_ANIMATION_LAST.
*
+ * Rename: clutter_alpha_register_func
+ *
* Return value: the logical id of the alpha function
*
* Since: 1.0
* Start the ClutterAnimator, this is a thin wrapper that rewinds
* and starts the animators current timeline.
*
- * Return value: the #ClutterTimeline that drives the animator.
+ * Return value: (transfer none): the #ClutterTimeline that drives
+ * the animator. The returned timeline is owned by the #ClutterAnimator
+ * and it should not be unreferenced
*
* Since: 1.2
*/
/**
* clutter_behaviour_actors_foreach:
* @behave: a #ClutterBehaviour
- * @func: a function called for each actor
+ * @func: (scope call): a function called for each actor
* @data: optional data to be passed to the function, or %NULL
*
* Calls @func for every actor driven by @behave.
*
* Retrieves the #ClutterLayoutManager instance used by @box
*
- * Return value: a #ClutterLayoutManager
+ * Return value: (transfer none): a #ClutterLayoutManager. The returned
+ * #ClutterLayoutManager is owned by the #ClutterBox and it should not
+ * be unreferenced
*
* Since: 1.2
*/
/**
* clutter_container_foreach:
* @container: a #ClutterContainer
- * @callback: a function to be called for each child
+ * @callback: (scope call): a function to be called for each child
* @user_data: data to be passed to the function, or %NULL
*
* Calls @callback for each child of @container that was added
/**
* clutter_container_foreach_with_internals:
* @container: a #ClutterContainer
- * @callback: a function to be called for each child
+ * @callback: (scope call): a function to be called for each child
* @user_data: data to be passed to the function, or %NULL
*
* Calls @callback for each child of @container, including "internal"
* The #ClutterInputDevice structure is completely opaque and should
* be cast to the platform-specific implementation.
*
- * Return value: the #ClutterInputDevice or %NULL
+ * Return value: (transfer none): the #ClutterInputDevice or %NULL. The
+ * returned device is owned by the #ClutterEvent and it should not
+ * be unreferenced
*
* Since: 1.0
*/
*
* Creates a copy of @interval.
*
- * Return value: the newly created #ClutterInterval
+ * Return value: (transfer full): the newly created #ClutterInterval
*
* Since: 1.0
*/
}
/**
- * clutter_interval_register_progress_func:
+ * clutter_interval_register_progress_func: (skip):
* @value_type: a #GType
* @func: a #ClutterProgressFunc, or %NULL to unset a previously
* set progress function
* to the @actor child of @container, eventually by creating one if the
* #ClutterLayoutManager supports layout properties
*
- * Return value: a #ClutterLayoutMeta, or %NULL if the #ClutterLayoutManager
- * does not have layout properties
+ * Return value: (transfer none): a #ClutterLayoutMeta, or %NULL if the
+ * #ClutterLayoutManager does not have layout properties. The returned
+ * layout meta instance is owned by the #ClutterLayoutManager and it
+ * should not be unreferenced
*
* Since: 1.0
*/
/**
- * clutter_get_actor_by_gid
+ * clutter_get_actor_by_gid:
* @id: a #ClutterActor ID.
*
* Retrieves the #ClutterActor with @id.
/**
* clutter_path_foreach:
* @path: a #ClutterPath
- * @callback: the function to call with each node
+ * @callback: (scope call): the function to call with each node
* @user_data: user data to pass to the function
*
* Calls a function for each node of the path.
* This function allows to control how the signal handlers are
* going to be connected to their respective signals. It is meant
* primarily for language bindings to allow resolving the function
- * names using the native API.
+ * names using the native API, but it can also be used on platforms
+ * that do not support GModule.
*
* Applications should use clutter_script_connect_signals().
*
*
* Retrieves the underlying #CoglHandle for the shader program.
*
- * Return value: A #CoglHandle for the shader program, or %NULL
+ * Return value: (transfer none): A #CoglHandle for the shader program,
+ * or %NULL. The handle is owned by the #ClutterShader and it should
+ * not be unreferenced
*
* Since: 1.0
*/
*
* Retrieves the underlying #CoglHandle for the fragment shader.
*
- * Return value: A #CoglHandle for the fragment shader, or %NULL
+ * Return value: (transfer none): A #CoglHandle for the fragment
+ * shader, or %NULL. The handle is owned by the #ClutterShader
+ * and it should not be unreferenced
*
* Since: 1.0
*/
*
* Retrieves the underlying #CoglHandle for the vertex shader.
*
- * Return value: A #CoglHandle for the vertex shader, or %NULL
+ * Return value: (transfer none): A #CoglHandle for the vertex
+ * shader, or %NULL. The handle is owned by the #ClutterShader
+ * and it should not be unreferenced
*
* Since: 1.0
*/
* The state will animate during its transition, see
* #clutter_state_warp_to_state for animation-free state switching.
*
- * Return value: the #ClutterTimeline that drives the state transition
+ * Return value: (transfer none): the #ClutterTimeline that drives the
+ * state transition. The returned timeline is owned by the #ClutterState
+ * and it should not be unreferenced
*
* Since: 1.4
*/
*
* Change to the specified target state immediately with no animation.
*
- * Return value: the #ClutterTimeline that drives the state transition
+ * Return value: (transfer none): the #ClutterTimeline that drives the
+ * state transition. The returned timeline is owned by the #ClutterState
+ * and it should not be unreferenced
*
* Since: 1.4
*/
* Sets one specific end key for a state_name, object, property_name
* combination.
*
- * Return value: the #ClutterState instance, allowing chaining of
- * multiple calls
+ * Return value: (transfer none): the #ClutterState instance, allowing
+ * chaining of multiple calls
*
* Since: 1.4
*/
* @texture: A #ClutterTexture
*
* Returns a handle to the underlying COGL material used for drawing
- * the actor. No extra reference is taken so if you need to keep the
- * handle then you should call cogl_handle_ref() on it.
+ * the actor.
*
- * Since: 1.0
+ * Return value: (transfer none): a handle for a #CoglMaterial. The
+ * material is owned by the #ClutterTexture and it should not be
+ * unreferenced
*
- * Return value: COGL material handle
+ * Since: 1.0
*/
CoglHandle
clutter_texture_get_cogl_material (ClutterTexture *texture)
}
/**
- * clutter_texture_get_cogl_texture
+ * clutter_texture_get_cogl_texture:
* @texture: A #ClutterTexture
*
* Retrieves the handle to the underlying COGL texture used for drawing
* layers you should use clutter_texture_get_cogl_material() instead
* and use the #CoglMaterial API.
*
- * Since: 0.8
+ * Return value: (transfer none): a #CoglHandle for the texture. The returned
+ * handle is owned by the #ClutterTexture and it should not be unreferenced
*
- * Return value: COGL texture handle
+ * Since: 0.8
*/
CoglHandle
clutter_texture_get_cogl_texture (ClutterTexture *texture)
* be started and will not be positioned to the current position of
* @timeline: you will have to start it with clutter_timeline_start().
*
- * Return Value: a new #ClutterTimeline, cloned from @timeline
+ * Return Value: (transfer full): a new #ClutterTimeline, cloned
+ * from @timeline
*
* Since: 0.4
*/
* negative integer, all the markers attached to @timeline will be
* returned.
*
- * Return value: (array zero-terminated=1 length=n_markers): a newly
- * allocated, %NULL terminated string array containing the names of
- * the markers. Use g_strfreev() when done.
+ * Return value: (transfer full) (array zero-terminated=1 length=n_markers):
+ * a newly allocated, %NULL terminated string array containing the names
+ * of the markers. Use g_strfreev() when done.
*
* Since: 0.8
*/
projects / profile / ivi / clutter.git / commitdiff