Fixing documentation for HildonBanner. Fixing documentation for HildonCaption. Fixing...

diff --git a/ChangeLog.2 b/ChangeLog.2
index 0c1f246..eb1f38c 100644 (file)
--- a/ChangeLog.2
+++ b/ChangeLog.2
@@ -1,5 +1,16 @@
 2007-01-23  Michael Dominic Kostrzewa  <michael.kostrzewa@nokia.com> 
 
+       * src/hildon-banner.c: Fixing documentation for HildonBanner.
+
+       * src/hildon-caption.c:
+       * src/hildon-caption.h: Fixing documentation for HildonCaption.
+
+       * src/hildon-code-dialog.c: Fixing documentation for HildonCodeDialog.
+
+       * src/hildon-controlbar.c: Fixing docuemtnation for HildonControlbar.
+
+2007-01-23  Michael Dominic Kostrzewa  <michael.kostrzewa@nokia.com> 
+
        * src/hildon-banner.c:
        * src/hildon-banner.h: Fixing documentation. Removing the n-lines
        helper function.

diff --git a/src/hildon-banner.c b/src/hildon-banner.c
index 8857713..5d347b0 100644 (file)
--- a/src/hildon-banner.c
+++ b/src/hildon-banner.c
@@ -22,6 +22,18 @@
  *
  */
 
+/**
+ * SECTION:hildon-banner 
+ * @short_description: A widget used to display timed notifications. 
+ *
+ * #HildonBanner can be used to display a short, timed notification 
+ * or information to the user. It can communicate that a 
+ * task has been finished or the application state has changed.
+ * Banners should be used only to display non-critical pieces of 
+ * information.
+ *
+ */
+
 #ifdef                                          HAVE_CONFIG_H
 #include                                        <config.h>
 #endif

diff --git a/src/hildon-caption.c b/src/hildon-caption.c
index 34f850e..34ec248 100644 (file)
--- a/src/hildon-caption.c
+++ b/src/hildon-caption.c
@@ -153,7 +153,7 @@ enum
 /**
  * hildon_caption_get_type:
  *
- * Initialises, and returns the type of a hildon caption.
+ * Initializes and returns the type of a hildon caption.
  *
  * @Returns: GType of #HildonCaption
  */
@@ -1063,7 +1063,8 @@ hildon_caption_get_label                        (const HildonCaption *caption)
  * The default seaparator character is ":"
  * separately.
  */
-void hildon_caption_set_separator               (HildonCaption *caption, 
+void 
+hildon_caption_set_separator                    (HildonCaption *caption, 
                                                  const gchar *separator)
 {
     g_return_if_fail (HILDON_IS_CAPTION (caption));
@@ -1110,7 +1111,7 @@ hildon_caption_activate                         (GtkWidget *widget)
 /**
  * hildon_caption_set_child_expand:
  * @caption : a #HildonCaption
- * @expand : gboolean to determine is the child expandable
+ * @expand : gboolean to determine if the child is expandable
  *
  * Sets child expandability.
  */

diff --git a/src/hildon-caption.h b/src/hildon-caption.h
index a53f4c0..4626f87 100644 (file)
--- a/src/hildon-caption.h
+++ b/src/hildon-caption.h
@@ -72,7 +72,6 @@ typedef enum
  *
  * Keys to set the icon placement in #HildonCaption.
  *
- * Since: 0.14.5
  */
 typedef enum
 {

diff --git a/src/hildon-code-dialog.c b/src/hildon-code-dialog.c
index f096ea1..b7fb40a 100644 (file)
--- a/src/hildon-code-dialog.c
+++ b/src/hildon-code-dialog.c
@@ -22,6 +22,17 @@
  *
  */
 
+/**
+ * SECTION:hildon-code-dialog
+ * @short_description: A keypad-like widget used to enter pincodes.
+ *
+ * #HildonCodeDialog displays a keypad that can be used to enter 
+ * numerical pin codes or lock codes. 
+ *
+ */
+
+/* FIXME We need property access in this widget */
+
 #ifdef                                          HAVE_CONFIG_H
 #include                                        <config.h>
 #endif
@@ -88,6 +99,13 @@ hildon_code_dialog_key_press_event              (GtkWidget *widget,
 
 static GtkDialogClass*                          parent_class = NULL;
 
+/**
+ * hildon_code_dialog_get_type:
+ *
+ * Initializes and returns the type of a hildon code dialog.
+ *
+ * @Returns: GType of #HildonCodeDialog
+ */
 GType G_GNUC_CONST
 hildon_code_dialog_get_type                     (void)
 {

diff --git a/src/hildon-controlbar.c b/src/hildon-controlbar.c
index 539d081..4737e06 100644 (file)
--- a/src/hildon-controlbar.c
+++ b/src/hildon-controlbar.c
@@ -139,6 +139,13 @@ hildon_controlbar_change_value                  (GtkRange *range,
                                                  gdouble new_value, 
                                                  gpointer data);
 
+/**
+ * hildon_controlbar_get_type:
+ *
+ * Initializes and returns the type of a hildon control bar.
+ *
+ * @Returns: GType of #HildonControlbar
+ */
 GType G_GNUC_CONST
 hildon_controlbar_get_type                      (void)
 {
@@ -213,7 +220,7 @@ hildon_controlbar_class_init                    (HildonControlbarClass *controlb
     /**
      * HildonControlbar:value:
      *
-     * Controlbar value.
+     * Controlbar current value.
      */
     g_object_class_install_property (gobject_class, PROP_VALUE,
             g_param_spec_int ("value",
@@ -413,7 +420,7 @@ hildon_controlbar_size_request                  (GtkWidget *self,
  * @self: pointer to #HildonControlbar
  * @value: value in range of >= 0 && < G_MAX_INT
  *
- * Change the current value of the control bar to the specified value.
+ * Set the current value of the control bar to the specified value.
  */
 void 
 hildon_controlbar_set_value                     (HildonControlbar * self, 
@@ -576,7 +583,7 @@ hildon_controlbar_get_min                       (HildonControlbar *self)
  * Event handler for button press
  * Need to change button1 to button2 before passing this event to
  * parent handler. (see specs)
- * Also updates button_press variable so that we can draw hilites
+ * Also updates button_press variable so that we can draw highlights
  * correctly
  */
 static gint