[maemo-commits] [maemo-commits] r9705 - in projects/haf/branches/hildon-libs/hildon-1: . src

[From: subversion at stage.maemo.org]

Author: mdk
Date: 2007-02-07 13:35:26 +0200 (Wed, 07 Feb 2007)
New Revision: 9705

Modified:
   projects/haf/branches/hildon-libs/hildon-1/ChangeLog.2
   projects/haf/branches/hildon-libs/hildon-1/src/hildon-color-chooser-dialog.c
   projects/haf/branches/hildon-libs/hildon-1/src/hildon-color-chooser.c
Log:
Small documentation fixes for the color widgets.


Modified: projects/haf/branches/hildon-libs/hildon-1/ChangeLog.2
===================================================================
--- projects/haf/branches/hildon-libs/hildon-1/ChangeLog.2	2007-02-07 10:53:22 UTC (rev 9704)
+++ projects/haf/branches/hildon-libs/hildon-1/ChangeLog.2	2007-02-07 11:35:26 UTC (rev 9705)
@@ -1,3 +1,8 @@
+2007-02-07  Michael Dominic Kostrzewa  <michael.kostrzewa at nokia.com> 
+
+	* src/hildon-color-chooser-dialog.c:
+	* src/hildon-color-chooser.c: Small documentation fixes.
+
 2007-02-06  Michael Dominic Kostrzewa  <michael.kostrzewa at nokia.com> 
 
 	* examples/Makefile.am:

Modified: projects/haf/branches/hildon-libs/hildon-1/src/hildon-color-chooser-dialog.c
===================================================================
--- projects/haf/branches/hildon-libs/hildon-1/src/hildon-color-chooser-dialog.c	2007-02-07 10:53:22 UTC (rev 9704)
+++ projects/haf/branches/hildon-libs/hildon-1/src/hildon-color-chooser-dialog.c	2007-02-07 11:35:26 UTC (rev 9705)
@@ -38,7 +38,6 @@
  *
  */
 
-
 #ifdef                                          HAVE_CONFIG_H
 #include                                        <config.h>
 #endif
@@ -780,6 +779,17 @@
     GTK_OBJECT_CLASS (parent_class)->destroy (object);
 }
 
+/**
+ * hildon_color_chooser_dialog_set_color:
+ * @dialog: a #HildonColorChooserDialog
+ * @color: a color to set on the #HildonColorChooserDialog
+ *
+ * Sets the dialog to point at the given color. It'll first try to
+ * search the palette of the existing colors to match the passed color. 
+ * If the color is not found in the pallette, the color in the currently 
+ * selected box will be modified.
+ *
+ */
 void 
 hildon_color_chooser_dialog_set_color           (HildonColorChooserDialog *dialog, 
                                                  GdkColor *color)
@@ -1110,8 +1120,10 @@
 /**
  * hildon_color_chooser_dialog_get_color:
  * @dialog: a #HildonColorChooserDialog
- * @color: a color to fill with new value
+ * @color: a color structure to fill with the currently selected color
  *
+ * Retrives the currently selected color in the color chooser dialog.
+ *
  */
 void
 hildon_color_chooser_dialog_get_color           (HildonColorChooserDialog *dialog, 

Modified: projects/haf/branches/hildon-libs/hildon-1/src/hildon-color-chooser.c
===================================================================
--- projects/haf/branches/hildon-libs/hildon-1/src/hildon-color-chooser.c	2007-02-07 10:53:22 UTC (rev 9704)
+++ projects/haf/branches/hildon-libs/hildon-1/src/hildon-color-chooser.c	2007-02-07 11:35:26 UTC (rev 9705)
@@ -371,7 +371,6 @@
     }
 }
 
-
 static void
 hildon_color_chooser_realize                    (GtkWidget *widget)
 {
@@ -771,6 +770,7 @@
  * @color: a color to be set
  *
  * Sets the color selected in the widget.
+ * Will move the crosshair pointer to indicate the passed color.
  */
 void 
 hildon_color_chooser_set_color                  (HildonColorChooser *sel, 
@@ -1244,7 +1244,14 @@
     return FALSE;
 }
 
-/* FIXME Missing documentation */
+/**
+ * hildon_color_chooser_get_color:
+ * @dialog: a #HildonColorChooser
+ * @color: a color structure to fill with the currently selected color
+ *
+ * Retrives the currently selected color in the chooser.
+ *
+ */
 void
 hildon_color_chooser_get_color                  (HildonColorChooser *sel, 
                                                  GdkColor *color)