mirror of
https://github.com/brl/mutter.git
synced 2025-02-21 07:24:09 +00:00
docs: Fixes for TimeoutPool and Frame sources
The TimeoutPool is not used by ClutterTimeline any more, so we need to remove a sentence from its description. We also need to fix the gtk-doc syntax errors.
This commit is contained in:
parent
046a4b8047
commit
2d5eeba5d8
@ -39,7 +39,8 @@ struct _ClutterFrameSource
|
|||||||
ClutterTimeoutInterval timeout;
|
ClutterTimeoutInterval timeout;
|
||||||
};
|
};
|
||||||
|
|
||||||
static gboolean clutter_frame_source_prepare (GSource *source, gint *timeout);
|
static gboolean clutter_frame_source_prepare (GSource *source,
|
||||||
|
gint *timeout);
|
||||||
static gboolean clutter_frame_source_check (GSource *source);
|
static gboolean clutter_frame_source_check (GSource *source);
|
||||||
static gboolean clutter_frame_source_dispatch (GSource *source,
|
static gboolean clutter_frame_source_dispatch (GSource *source,
|
||||||
GSourceFunc callback,
|
GSourceFunc callback,
|
||||||
@ -56,7 +57,7 @@ static GSourceFuncs clutter_frame_source_funcs =
|
|||||||
/**
|
/**
|
||||||
* clutter_frame_source_add_full:
|
* clutter_frame_source_add_full:
|
||||||
* @priority: the priority of the frame source. Typically this will be in the
|
* @priority: the priority of the frame source. Typically this will be in the
|
||||||
* range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
|
* range between %G_PRIORITY_DEFAULT and %G_PRIORITY_HIGH.
|
||||||
* @fps: the number of times per second to call the function
|
* @fps: the number of times per second to call the function
|
||||||
* @func: function to call
|
* @func: function to call
|
||||||
* @data: data to pass to the function
|
* @data: data to pass to the function
|
||||||
|
@ -359,12 +359,6 @@ clutter_timeout_pool_finalize (GSource *source)
|
|||||||
* always sorted, so that the extraction of the next timeout function is
|
* always sorted, so that the extraction of the next timeout function is
|
||||||
* a constant time operation.
|
* a constant time operation.
|
||||||
*
|
*
|
||||||
* Inside Clutter, every #ClutterTimeline share the same timeout pool, unless
|
|
||||||
* the CLUTTER_TIMELINE=no-pool environment variable is set.
|
|
||||||
*
|
|
||||||
* #ClutterTimeoutPool is part of the #ClutterTimeline implementation
|
|
||||||
* and should not be used by application developers.
|
|
||||||
*
|
|
||||||
* Return value: the newly created #ClutterTimeoutPool. The created pool
|
* Return value: the newly created #ClutterTimeoutPool. The created pool
|
||||||
* is owned by the GLib default context and will be automatically
|
* is owned by the GLib default context and will be automatically
|
||||||
* destroyed when the context is destroyed. It is possible to force
|
* destroyed when the context is destroyed. It is possible to force
|
||||||
@ -412,7 +406,7 @@ clutter_timeout_pool_new (gint priority)
|
|||||||
* won't be called again. If @notify is not %NULL, the @notify function
|
* won't be called again. If @notify is not %NULL, the @notify function
|
||||||
* will be called. The first call to @func will be at the end of @interval.
|
* will be called. The first call to @func will be at the end of @interval.
|
||||||
*
|
*
|
||||||
* Since version 0.8 this will try to compensate for delays. For
|
* Since Clutter 0.8 this will try to compensate for delays. For
|
||||||
* example, if @func takes half the interval time to execute then the
|
* example, if @func takes half the interval time to execute then the
|
||||||
* function will be called again half the interval time after it
|
* function will be called again half the interval time after it
|
||||||
* finished. Before version 0.8 it would not fire until a full
|
* finished. Before version 0.8 it would not fire until a full
|
||||||
|
Loading…
x
Reference in New Issue
Block a user