Small documentation fixes for the color widgets.

diff --git a/ChangeLog.2 b/ChangeLog.2
index 9d5e140..359c98a 100644 (file)
--- a/ChangeLog.2
+++ b/ChangeLog.2
@@ -1,3 +1,8 @@
+2007-02-07  Michael Dominic Kostrzewa  <michael.kostrzewa@nokia.com> 
+
+       * src/hildon-color-chooser-dialog.c:
+       * src/hildon-color-chooser.c: Small documentation fixes.
+
 2007-02-06  Michael Dominic Kostrzewa  <michael.kostrzewa@nokia.com> 
 
        * examples/Makefile.am:

diff --git a/src/hildon-color-chooser-dialog.c b/src/hildon-color-chooser-dialog.c
index bd3589c..140d920 100644 (file)
--- a/src/hildon-color-chooser-dialog.c
+++ b/src/hildon-color-chooser-dialog.c
@@ -38,7 +38,6 @@
  *
  */
 
-
 #ifdef                                          HAVE_CONFIG_H
 #include                                        <config.h>
 #endif
@@ -780,6 +779,17 @@ hildon_color_chooser_dialog_destroy             (GtkObject *object)
     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,7 +1120,9 @@ hildon_color_chooser_dialog_new                 (void)
 /**
  * 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

diff --git a/src/hildon-color-chooser.c b/src/hildon-color-chooser.c
index 436cd6b..dbdc285 100644 (file)
--- a/src/hildon-color-chooser.c
+++ b/src/hildon-color-chooser.c
@@ -371,7 +371,6 @@ hildon_color_chooser_size_allocate              (GtkWidget *widget,
     }
 }
 
-
 static void
 hildon_color_chooser_realize                    (GtkWidget *widget)
 {
@@ -771,6 +770,7 @@ init_borders                                    (GtkWidget *w,
  * @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 @@ hildon_color_chooser_expose_timer               (gpointer data)
     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)