More docs

diff --git a/ChangeLog b/ChangeLog
index 1518af0..73006e9 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2006-06-22  Iain Holmes  <iain@openedhand.com>
+
+       * clutter/clutter-group.c: More typo fixes
+
+       * clutter/clutter-event.c: Documentation
+
 2006-06-22  Emmanuele Bassi  <ebassi@openedhand.com>
 
        * clutter/clutter-timeline.h:

diff --git a/clutter/clutter-event.c b/clutter/clutter-event.c
index d82ee08..8e7c074 100644 (file)
--- a/clutter/clutter-event.c
+++ b/clutter/clutter-event.c
@@ -996,6 +996,14 @@ clutter_keysym_to_unicode (guint keyval)
   return 0;
 }
 
+/**
+ * clutter_event_new:
+ * @type: The type of event.
+ *
+ * Creates a new #ClutterEvent of the specified type.
+ *
+ * Return value: A newly allocaed #ClutterEvent.
+ */
 ClutterEvent *
 clutter_event_new (ClutterEventType type)
 {
@@ -1007,6 +1015,14 @@ clutter_event_new (ClutterEventType type)
   return new_event;
 }
 
+/**
+ * clutter_event_copy:
+ * @event: A #ClutterEvent.
+ *
+ * Copies @event.
+ *
+ * Return value: A newly allocated #ClutterEvent
+ */
 ClutterEvent *
 clutter_event_copy (ClutterEvent *event)
 {
@@ -1020,6 +1036,12 @@ clutter_event_copy (ClutterEvent *event)
   return new_event;
 }
 
+/**
+ * clutter_event_free:
+ * @event: A #ClutterEvent.
+ *
+ * Frees all resources used by @event.
+ */
 void
 clutter_event_free (ClutterEvent *event)
 {

diff --git a/clutter/clutter-group.c b/clutter/clutter-group.c
index a7fefef..e4c488b 100644 (file)
--- a/clutter/clutter-group.c
+++ b/clutter/clutter-group.c
@@ -309,7 +309,7 @@ clutter_group_get_children (ClutterGroup *self)
 }
 
 /**
- * clutter_group_forall:
+ * clutter_group_foreach:
  * @self: A #ClutterGroup
  * @callback: a callback
  * @user_data: callback user data 
@@ -674,7 +674,7 @@ sort_z_order (gconstpointer a, gconstpointer b)
 }
 
 /**
- * clutter_group_sort_z_order:
+ * clutter_group_sort_depth_order:
  * @self: A #ClutterGroup
  *
  * Sorts a #ClutterGroup's children by there depth value.  

diff --git a/doc/reference/tmpl/clutter-main.sgml b/doc/reference/tmpl/clutter-main.sgml
index b64dc4e..3e539ac 100644 (file)
--- a/doc/reference/tmpl/clutter-main.sgml
+++ b/doc/reference/tmpl/clutter-main.sgml
@@ -67,6 +67,8 @@ clutter-main
 @a...:
 @a...:
 @a...:
+@a...:
+@a...:
 @a...: