[clutter] docs: Documentation fixes
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [clutter] docs: Documentation fixes
- Date: Thu, 23 Feb 2012 12:16:44 +0000 (UTC)
commit 39a75436bf93ef5349449feb6e19c27b3088d9c9
Author: Emmanuele Bassi <ebassi linux intel com>
Date: Thu Feb 23 12:01:11 2012 +0000
docs: Documentation fixes
clutter/clutter-actor-meta.h | 6 +++++-
clutter/clutter-actor.c | 2 +-
clutter/clutter-text-buffer.h | 12 +++++++++---
clutter/gdk/clutter-backend-gdk.c | 13 +++++++++++++
4 files changed, 28 insertions(+), 5 deletions(-)
---
diff --git a/clutter/clutter-actor-meta.h b/clutter/clutter-actor-meta.h
index ab4b49b..fa3fafe 100644
--- a/clutter/clutter-actor-meta.h
+++ b/clutter/clutter-actor-meta.h
@@ -78,7 +78,11 @@ struct _ClutterActorMetaClass
/**
* ClutterActorMetaClass::set_actor:
- * @actor: (allow-none):
+ * @meta: a #ClutterActorMeta
+ * @actor: (allow-none): the actor attached to @meta, or %NULL
+ *
+ * Virtual function, called when @meta is attached or detached
+ * from a #ClutterActor.
*/
void (* set_actor) (ClutterActorMeta *meta,
ClutterActor *actor);
diff --git a/clutter/clutter-actor.c b/clutter/clutter-actor.c
index eb8516b..0dd2205 100644
--- a/clutter/clutter-actor.c
+++ b/clutter/clutter-actor.c
@@ -15743,7 +15743,7 @@ clutter_actor_iter_next (ClutterActorIter *iter,
}
/**
- * clutter_actor_iter_next:
+ * clutter_actor_iter_prev:
* @iter: a #ClutterActorIter
* @child: (out): return location for a #ClutterActor
*
diff --git a/clutter/clutter-text-buffer.h b/clutter/clutter-text-buffer.h
index a21e3ac..06a6f94 100644
--- a/clutter/clutter-text-buffer.h
+++ b/clutter/clutter-text-buffer.h
@@ -30,9 +30,6 @@
G_BEGIN_DECLS
-/* Maximum size of text buffer, in bytes */
-#define CLUTTER_TEXT_BUFFER_MAX_SIZE G_MAXUSHORT
-
#define CLUTTER_TYPE_TEXT_BUFFER (clutter_text_buffer_get_type ())
#define CLUTTER_TEXT_BUFFER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_TEXT_BUFFER, ClutterTextBuffer))
#define CLUTTER_TEXT_BUFFER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), CLUTTER_TYPE_TEXT_BUFFER, ClutterTextBufferClass))
@@ -40,6 +37,15 @@ G_BEGIN_DECLS
#define CLUTTER_IS_TEXT_BUFFER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), CLUTTER_TYPE_TEXT_BUFFER))
#define CLUTTER_TEXT_BUFFER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), CLUTTER_TYPE_TEXT_BUFFER, ClutterTextBufferClass))
+/**
+ * CLUTTER_TEXT_BUFFER_MAX_SIZE:
+ *
+ * Maximum size of text buffer, in bytes.
+ *
+ * Since: 1.10
+ */
+#define CLUTTER_TEXT_BUFFER_MAX_SIZE G_MAXUSHORT
+
typedef struct _ClutterTextBuffer ClutterTextBuffer;
typedef struct _ClutterTextBufferClass ClutterTextBufferClass;
typedef struct _ClutterTextBufferPrivate ClutterTextBufferPrivate;
diff --git a/clutter/gdk/clutter-backend-gdk.c b/clutter/gdk/clutter-backend-gdk.c
index 00e5599..4660525 100644
--- a/clutter/gdk/clutter-backend-gdk.c
+++ b/clutter/gdk/clutter-backend-gdk.c
@@ -443,6 +443,19 @@ clutter_gdk_set_display (GdkDisplay *display)
_foreign_dpy = g_object_ref (display);
}
+/**
+ * clutter_gdk_disable_event_retrieval:
+ *
+ * Disable the event retrieval in Clutter.
+ *
+ * Callers of this function have to set up an event filter using the
+ * GDK API, and call clutter_gdk_handle_event().
+ *
+ * This function should only be used when embedding Clutter into
+ * a GDK based toolkit.
+ *
+ * Since: 1.10
+ */
void
clutter_gdk_disable_event_retrieval (void)
{
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]