2007-08-20 Emmanuele Bassi <ebassi@openedhand.com>

	* doc/reference/clutter-gtk-sections.txt:
	* doc/reference/clutter-gtk-docs.sgml:
	* clutter-gtk/clutter-gtk.[ch]: Fix API reference.

	* examples/Makefile.am: Fix compilation of the examples

diff --git a/ChangeLog b/ChangeLog
index d07dfca..aa0cb93 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2007-08-20  Emmanuele Bassi  <ebassi@openedhand.com>
+
+       * doc/reference/clutter-gtk-sections.txt:
+       * doc/reference/clutter-gtk-docs.sgml:
+       * clutter-gtk/clutter-gtk.[ch]: Fix API reference.
+
+       * examples/Makefile.am: Fix compilation of the examples
+
 2007-08-15  Emmanuele Bassi  <ebassi@openedhand.com>
 
        * configure.ac:

diff --git a/clutter-gtk/clutter-gtk.c b/clutter-gtk/clutter-gtk.c
index 59f8154..83f3904 100644 (file)
--- a/clutter-gtk/clutter-gtk.c
+++ b/clutter-gtk/clutter-gtk.c
@@ -27,7 +27,7 @@
  * SECTION:gtk-clutter
  * @short_description: GTK+ widget displaying a #ClutterStage.
  *
- * #GtkClutter is a GTK+ widget, derived from #GtkSocket that contains a
+ * #GtkClutter is a GTK+ widget, derived from #GtkSocket, that contains a
  * #ClutterStage, allowing it to be used in a GTK+ based program like any 
  * normal GTK+ widget.
  */
@@ -195,7 +195,7 @@ gtk_clutter_init (GtkClutter *clutter)
  *
  * Obtains the #ClutterStage associated with this object.
  *
- * Return value: A #ClutterActor.
+ * Return value: the main stage
  */
 ClutterActor *
 gtk_clutter_get_stage (GtkClutter *clutter)
@@ -205,6 +205,18 @@ gtk_clutter_get_stage (GtkClutter *clutter)
   return clutter->priv->stage;
 }
 
+/**
+ * gtk_clutter_new:
+ * 
+ * Creates a new #GtkClutter widget. You can use this widget inside
+ * any GTK+ application. Once you added it to a container you should
+ * call gtk_clutter_get_stage() to obtain the #ClutterStage and add
+ * Clutter actors to it.
+ *
+ * All the mouse events will be forwarded to the stage.
+ *
+ * Return value: the newly created #GtkClutter widget
+ */
 GtkWidget *
 gtk_clutter_new (void)
 {

diff --git a/clutter-gtk/clutter-gtk.h b/clutter-gtk/clutter-gtk.h
index c887bba..71340c1 100644 (file)
--- a/clutter-gtk/clutter-gtk.h
+++ b/clutter-gtk/clutter-gtk.h
@@ -59,14 +59,15 @@ typedef struct _GtkClutterPrivate       GtkClutterPrivate;
 
 struct _GtkClutter 
 {
-  GtkSocket parent;
-
   /*< private >*/
+  GtkSocket parent;
+  
   GtkClutterPrivate *priv;
 };
 
 struct _GtkClutterClass
 {
+  /*< private >*/
   GtkSocketClass parent_class;
 
   void (*_gtk_clutter_1) (void);
@@ -79,7 +80,7 @@ struct _GtkClutterClass
 
 GType gtk_clutter_get_type (void) G_GNUC_CONST;
 
-GtkWidget    *gtk_clutter_new       (void);
+GtkWidget *   gtk_clutter_new       (void);
 ClutterActor *gtk_clutter_get_stage (GtkClutter *clutter);
 
 G_END_DECLS

diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index ed4fd5b..f0e25a9 100644 (file)
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -21,7 +21,7 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
 DOC_SOURCE_DIR=../../clutter-gtk
 
 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
-SCANGOBJ_OPTIONS=--type-init-func="clutter_init(0,0)"
+SCANGOBJ_OPTIONS=--type-init-func="clutter_base_init()"
 
 # Extra options to supply to gtkdoc-scan.
 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" 

diff --git a/doc/reference/clutter-gtk-docs.sgml b/doc/reference/clutter-gtk-docs.sgml
index 93f29ad..05899db 100644 (file)
--- a/doc/reference/clutter-gtk-docs.sgml
+++ b/doc/reference/clutter-gtk-docs.sgml
@@ -47,7 +47,7 @@
   </chapter>    
   <chapter>
     <title>Clutter-Gtk Widgets</title>
-    <xi:include href="xml/clutter-gtk.xml"/>
+    <xi:include href="xml/gtk-clutter.xml"/>
   </chapter>
 
   <appendix id="license">

diff --git a/examples/Makefile.am b/examples/Makefile.am
index 14335a8..5325c46 100644 (file)
--- a/examples/Makefile.am
+++ b/examples/Makefile.am
@@ -7,18 +7,18 @@ INCLUDES = \
        $(GTK_CFLAGS)
 
 gtk_clutter_test_DEPENDENCIES = \
-       $(top_builddir)/clutter-gtk/libclutter-gtk-0.4.la
+       $(top_builddir)/clutter-gtk/libclutter-gtk-0.5.la
 gtk_clutter_test_SOURCES = gtk-clutter-test.c
 gtk_clutter_test_LDADD = \
-       $(top_builddir)/clutter-gtk/libclutter-gtk-0.4.la \
+       $(top_builddir)/clutter-gtk/libclutter-gtk-0.5.la \
        $(CLUTTER_LIBS) \
        $(GTK_LIBS)
 
 gtk_clutter_events_DEPENDENCIES = \
-       $(top_builddir)/clutter-gtk/libclutter-gtk-0.4.la
+       $(top_builddir)/clutter-gtk/libclutter-gtk-0.5.la
 gtk_clutter_events_SOURCES = gtk-clutter-events.c
 gtk_clutter_events_LDADD = \
-       $(top_builddir)/clutter-gtk/libclutter-gtk-0.4.la \
+       $(top_builddir)/clutter-gtk/libclutter-gtk-0.5.la \
        $(CLUTTER_LIBS) \
        $(GTK_LIBS)