Commit 6b70343d authored by Emmanuele Bassi's avatar Emmanuele Bassi

docs: Minimal fixes for the API reference

parent a9861b34
......@@ -12315,7 +12315,7 @@ clutter_actor_remove_clip (ClutterActor *self)
*
* Return value: %TRUE if the actor has a clip area set.
*
* Since: 0.1.1
* Since: 0.2
*/
gboolean
clutter_actor_has_clip (ClutterActor *self)
......@@ -13082,7 +13082,7 @@ clutter_actor_get_parent (ClutterActor *self)
*
* Return Value: %TRUE if the actor is visibile and will be painted.
*
* Since: 0.8.4
* Since: 0.8
*/
gboolean
clutter_actor_get_paint_visibility (ClutterActor *actor)
......@@ -13297,7 +13297,7 @@ clutter_actor_replace_child (ClutterActor *self,
* This function should only be called by legacy #ClutterActor<!-- -->s
* implementing the #ClutterContainer interface.
*
* Since: 0.1.1
* Since: 0.2
*
* Deprecated: 1.10: Use clutter_actor_remove_child() instead.
*/
......
......@@ -952,7 +952,7 @@ clutter_color_free (ClutterColor *color)
* Return value: (transfer full): the newly allocated color.
* Use clutter_color_free() when done
*
* Since: 0.8.4
* Since: 0.8
*/
ClutterColor *
clutter_color_new (guint8 red,
......@@ -1062,7 +1062,7 @@ G_DEFINE_BOXED_TYPE_WITH_CODE (ClutterColor, clutter_color,
*
* Sets @value to @color.
*
* Since: 0.8.4
* Since: 0.8
*/
void
clutter_value_set_color (GValue *value,
......@@ -1081,7 +1081,7 @@ clutter_value_set_color (GValue *value,
*
* Return value: (transfer none): the color inside the passed #GValue
*
* Since: 0.8.4
* Since: 0.8
*/
const ClutterColor *
clutter_value_get_color (const GValue *value)
......@@ -1176,7 +1176,7 @@ clutter_param_color_get_type (void)
*
* Return value: the newly created #GParamSpec
*
* Since: 0.8.4
* Since: 0.8
*/
GParamSpec *
clutter_param_spec_color (const gchar *name,
......
......@@ -126,7 +126,7 @@ _clutter_feature_init (GError **error)
*
* Return value: %TRUE if a feature is available
*
* Since: 0.1.1
* Since: 0.2
*/
gboolean
clutter_feature_available (ClutterFeatureFlags feature)
......@@ -147,7 +147,7 @@ clutter_feature_available (ClutterFeatureFlags feature)
*
* Return value: a logical OR of all the supported features.
*
* Since: 0.1.1
* Since: 0.2
*/
ClutterFeatureFlags
clutter_feature_get_all (void)
......
......@@ -57,7 +57,7 @@ typedef struct _ClutterGroupPrivate ClutterGroupPrivate;
* The #ClutterGroup structure contains only private data
* and should be accessed using the provided API
*
* Since: 0.1
* Since: 0.2
*/
struct _ClutterGroup
{
......@@ -72,7 +72,7 @@ struct _ClutterGroup
*
* The #ClutterGroupClass structure contains only private data
*
* Since: 0.1
* Since: 0.2
*/
struct _ClutterGroupClass
{
......
......@@ -1740,7 +1740,7 @@ clutter_get_option_group (void)
* Return value: (transfer full): a #GOptionGroup for the commandline arguments
* recognized by Clutter
*
* Since: 0.8.2
* Since: 0.8
*/
GOptionGroup *
clutter_get_option_group_without_init (void)
......
......@@ -1397,7 +1397,7 @@ clutter_script_lookup_filename (ClutterScript *script,
* #ClutterScript instance. Use g_list_free() on the returned list when
* done.
*
* Since: 0.8.2
* Since: 0.8
*/
GList *
clutter_script_list_objects (ClutterScript *script)
......
......@@ -1986,7 +1986,7 @@ clutter_stage_class_init (ClutterStageClass *klass)
* The parameters used for the perspective projection from 3D
* coordinates to 2D
*
* Since: 0.8.2
* Since: 0.8
*/
pspec = g_param_spec_boxed ("perspective",
P_("Perspective"),
......
......@@ -50,7 +50,7 @@ typedef struct _ClutterStagePrivate ClutterStagePrivate;
* The #ClutterStage structure contains only private data
* and should be accessed using the provided API
*
* Since: 0.1
* Since: 0.2
*/
struct _ClutterStage
{
......@@ -69,7 +69,7 @@ struct _ClutterStage
*
* The #ClutterStageClass structure contains only private data
*
* Since: 0.1
* Since: 0.2
*/
struct _ClutterStageClass
......
......@@ -151,8 +151,8 @@ out:
/**
* clutter_test_add: (skip)
* @test_path:
* @test_func:
* @test_path: unique path for identifying the test
* @test_func: function containing the test
*
* Adds a test unit to the Clutter test environment.
*
......@@ -169,9 +169,9 @@ clutter_test_add (const char *test_path,
/**
* clutter_test_add_data: (skip)
* @test_path:
* @test_func:
* @test_data:
* @test_path: unique path for identifying the test
* @test_func: function containing the test
* @test_data: data to pass to the test function
*
* Adds a test unit to the Clutter test environment.
*
......@@ -189,10 +189,10 @@ clutter_test_add_data (const char *test_path,
/**
* clutter_test_add_data_full:
* @test_path:
* @test_func: (scope notified)
* @test_data:
* @test_notify:
* @test_path: unique path for identifying the test
* @test_func: (scope notified): function containing the test
* @test_data: (closure): data to pass to the test function
* @test_notify: function called when the test function ends
*
* Adds a test unit to the Clutter test environment.
*
......
......@@ -80,7 +80,7 @@ typedef struct _ClutterTexturePrivate ClutterTexturePrivate;
* The #ClutterTexture structure contains only private data
* and should be accessed using the provided API
*
* Since: 0.1
* Since: 0.2
*/
struct _ClutterTexture
{
......@@ -98,7 +98,7 @@ struct _ClutterTexture
*
* The #ClutterTextureClass structure contains only private data
*
* Since: 0.1
* Since: 0.2
*/
struct _ClutterTextureClass
{
......
......@@ -51,7 +51,7 @@ typedef struct _ClutterRectanglePrivate ClutterRectanglePrivate;
* The #ClutterRectangle structure contains only private data
* and should be accessed using the provided API
*
* Since: 0.1
* Since: 0.2
*/
struct _ClutterRectangle
{
......@@ -66,7 +66,7 @@ struct _ClutterRectangle
*
* The #ClutterRectangleClass structure contains only private data
*
* Since: 0.1
* Since: 0.2
*/
struct _ClutterRectangleClass
{
......
......@@ -1933,8 +1933,8 @@ clutter_evdev_set_keyboard_layout_index (ClutterDeviceManager *evdev,
* clutter_evdev_set_pointer_constrain_callback:
* @evdev: the #ClutterDeviceManager created by the evdev backend
* @callback: the callback
* @user_data:
* @user_data_notify:
* @user_data: data to pass to the callback
* @user_data_notify: function to be called when removing the callback
*
* Sets a callback to be invoked for every pointer motion. The callback
* can then modify the new pointer coordinates to constrain movement within
......
......@@ -68,7 +68,7 @@ void clutter_evdev_reclaim_devices (void);
* @time: the event time in milliseconds
* @x: (inout): the new X coordinate
* @y: (inout): the new Y coordinate
* @user_data:
* @user_data: user data passed to this function
*
* This callback will be called for all pointer motion events, and should
* update (@x, @y) to constrain the pointer position appropriately.
......@@ -77,6 +77,8 @@ void clutter_evdev_reclaim_devices (void);
* must make sure that this happens before it returns.
* Also note that the event will be emitted even if the pointer is constrained
* to be in the same position.
*
* Since: 1.16
*/
typedef void (*ClutterPointerConstrainCallback) (ClutterInputDevice *device,
guint32 time,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment