r3025 - in trunk/src/target/OM-2007.2/libraries/libmokoui2: . libmokoui

[thomas at sita.openmoko.org]

Author: thomas
Date: 2007-09-21 12:58:45 +0200 (Fri, 21 Sep 2007)
New Revision: 3025

Modified:
   trunk/src/target/OM-2007.2/libraries/libmokoui2/ChangeLog
   trunk/src/target/OM-2007.2/libraries/libmokoui2/libmokoui/moko-finger-scroll.c
Log:
* libmokoui/moko-finger-scroll.c: (moko_finger_scroll_init),
(moko_finger_scroll_new), (moko_finger_scroll_new_full):
Complete the documentation for MokoFingerScroll


Modified: trunk/src/target/OM-2007.2/libraries/libmokoui2/ChangeLog
===================================================================
--- trunk/src/target/OM-2007.2/libraries/libmokoui2/ChangeLog	2007-09-21 10:53:36 UTC (rev 3024)
+++ trunk/src/target/OM-2007.2/libraries/libmokoui2/ChangeLog	2007-09-21 10:58:45 UTC (rev 3025)
@@ -1,3 +1,9 @@
+2007-09-21  Thomas Wood  <thomas at openedhand.com>
+
+	* libmokoui/moko-finger-scroll.c: (moko_finger_scroll_init),
+	(moko_finger_scroll_new), (moko_finger_scroll_new_full):
+	Complete the documentation for MokoFingerScroll
+
 2007-09-21  Chris Lord  <chris at openedhand.com>
 
 	* libmokoui/moko-finger-scroll.c: (moko_finger_scroll_class_init),

Modified: trunk/src/target/OM-2007.2/libraries/libmokoui2/libmokoui/moko-finger-scroll.c
===================================================================
--- trunk/src/target/OM-2007.2/libraries/libmokoui2/libmokoui/moko-finger-scroll.c	2007-09-21 10:53:36 UTC (rev 3024)
+++ trunk/src/target/OM-2007.2/libraries/libmokoui2/libmokoui/moko-finger-scroll.c	2007-09-21 10:58:45 UTC (rev 3025)
@@ -783,11 +783,12 @@
 		G_CALLBACK (moko_finger_scroll_redraw), self);
 }
 
-/** moko_finger_scroll_new:
+/**
+ * moko_finger_scroll_new:
  * 
  * Create a new finger scroll widget
  *
- * Returns: the newly created widget
+ * Returns: the newly created #MokoFingerScroll
  */
 
 GtkWidget *
@@ -796,6 +797,20 @@
 	return g_object_new (MOKO_TYPE_FINGER_SCROLL, NULL);
 }
 
+/**
+ * moko_finger_scroll_new_full:
+ * @mode: #MokoFingerScrollMode
+ * @enabled: Value for the enabled property
+ * @vel_min: Value for the velocity-min property
+ * @vel_max: Value for the velocity-max property
+ * @decel: Value for the deceleration property
+ * @sps: Value for the sps property
+ *
+ * Create a new #MokoFingerScroll widget and set various properties
+ *
+ * returns: the newly create #MokoFingerScrull
+ */
+
 GtkWidget *
 moko_finger_scroll_new_full (gint mode, gboolean enabled,
 			     gdouble vel_min, gdouble vel_max,
@@ -811,12 +826,12 @@
 			     NULL);
 }
 
-/** moko_finger_scroll_add_with_viewport:
+/**
+ * moko_finger_scroll_add_with_viewport:
+ * @self: A #MokoFingerScroll
+ * @child: Child widget to add to the viewport
  *
- * @self: A MokoFingerScroll widget
- * @child: widget you want to add
- *
- * Convenience function used to add a child to a GtkViewport, and add the
+ * Convenience function used to add a child to a #GtkViewport, and add the
  * viewport to the scrolled window.
  */