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

[From: subversion at stage.maemo.org]

Author: mdk
Date: 2007-01-31 16:28:11 +0200 (Wed, 31 Jan 2007)
New Revision: 9499

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:
Fixing documentation in HildonColorChooser and HildonColorChooserDialog.


Modified: projects/haf/branches/hildon-libs/hildon-1/ChangeLog.2
===================================================================
--- projects/haf/branches/hildon-libs/hildon-1/ChangeLog.2	2007-01-31 13:25:54 UTC (rev 9498)
+++ projects/haf/branches/hildon-libs/hildon-1/ChangeLog.2	2007-01-31 14:28:11 UTC (rev 9499)
@@ -1,5 +1,10 @@
 2007-01-31  Michael Dominic Kostrzewa  <michael.kostrzewa at nokia.com> 
 
+	* src/hildon-color-chooser-dialog.c:
+	* src/hildon-color-chooser.c: Adding some documentation.
+
+2007-01-31  Michael Dominic Kostrzewa  <michael.kostrzewa at nokia.com> 
+
 	* configure.ac:
 	* pkgconfig/hildon.pc.in:
 	* src/hildon-seekbar.c: Xan's fixes for new gtk compilation.

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-01-31 13:25:54 UTC (rev 9498)
+++ projects/haf/branches/hildon-libs/hildon-1/src/hildon-color-chooser-dialog.c	2007-01-31 14:28:11 UTC (rev 9499)
@@ -23,6 +23,22 @@
  *
  */
 
+/**
+ * SECTION:hildon-color-chooser-dialog
+ * @short_description: A dialog used to select a color from HSV colorspace
+ * @see_also: #HildonColorButton
+ *
+ * HildonColorChooserDialog enables the user to 
+ * select an arbitrary color from a HSV colorspace.
+ * The color is stored in one of the predefined color 
+ * slots and can be reselected later on. 
+ *
+ * Additionally the user can choose one of the standard "factory"
+ * colors.
+ *
+ */
+
+
 #ifdef                                          HAVE_CONFIG_H
 #include                                        <config.h>
 #endif

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-01-31 13:25:54 UTC (rev 9498)
+++ projects/haf/branches/hildon-libs/hildon-1/src/hildon-color-chooser.c	2007-01-31 14:28:11 UTC (rev 9499)
@@ -23,6 +23,20 @@
  *
  */
 
+/**
+ * SECTION:hildon-color-chooser
+ * @short_description: A widget used to select a color from an HSV colorspace
+ * @see_also: #HildonColorChooserDialog
+ *
+ * HildonColorChooser is a widget that displays an HSV colorspace. 
+ * The user can manipulate the colorspace and easily select and shade of any color
+ * he wants. 
+ *
+ * Normally you should not need to use this widget directly. Using #HildonColorButton or
+ * #HildonColorChooserDialog is much more handy. 
+ * 
+ */
+
 #include                                        <gtk/gtk.h>
 #include                                        "hildon-color-chooser.h"
 #include                                        "hildon-color-chooser-private.h"