Removing accidentaly left function prototypes. Fixing documentation for HildonFindToo...

diff --git a/ChangeLog.2 b/ChangeLog.2
index b6d5312..a8e586f 100644 (file)
--- a/ChangeLog.2
+++ b/ChangeLog.2
@@ -1,5 +1,15 @@
 2007-01-23  Michael Dominic Kostrzewa  <michael.kostrzewa@nokia.com> 
 
+       * src/hildon-defines.h: Removing accidentaly left function prototypes.
+
+       * src/hildon-find-toolbar.c: Fixing documentation for
+       HildonFindToolbar.
+
+       * src/hildon-font-selection-dialog.c: Fixing documentation for
+       HildonfontSelectionDialog.
+
+2007-01-23  Michael Dominic Kostrzewa  <michael.kostrzewa@nokia.com> 
+
        * src/hildon-date-editor.c: Fixing the documentation for
        HildonTimeEditor. Removing the year limitations.
 

diff --git a/src/hildon-defines.h b/src/hildon-defines.h
index 99b93fa..40a5efc 100644 (file)
--- a/src/hildon-defines.h
+++ b/src/hildon-defines.h
@@ -22,6 +22,8 @@
  *
  */
 
+/* FIXME: Add documentation for the macros here */
+
 #ifndef                                         __HILDON_DEFINES_H__
 #define                                         __HILDON_DEFINES_H__
 

diff --git a/src/hildon-find-toolbar.c b/src/hildon-find-toolbar.c
index 006d5bb..22cdc33 100644 (file)
--- a/src/hildon-find-toolbar.c
+++ b/src/hildon-find-toolbar.c
@@ -24,8 +24,8 @@
 
 /**
  * SECTION:hildon-find-toolbar
- * @short_description: A special toolbar to be used with HildonAppView
- * @see_also: #HildonAppView
+ * @short_description: A special toolbar to be used with HildonWindow.
+ * @see_also: #HildonWindow
  *
  * HildonFindToolbar is a predefined toolbar for text searching purpose. 
  * It contains a GtkListStore which has the text items that the user has 
@@ -58,7 +58,7 @@
 #define                                         _(String) \
                                                 dgettext("hildon-libs", String)
 
-/*same define as gtkentry.c as entry will further handle this*/
+/* Same define as gtkentry.c as entry will further handle this */
 
 #define                                         MAX_SIZE G_MAXUSHORT
 
@@ -149,6 +149,13 @@ enum
 
 static guint                                    HildonFindToolbar_signal [LAST_SIGNAL] = {0};
 
+/**
+ * hildon_find_toolbar_get_type:
+ *
+ * Initializes and returns the type of a hildon fond toolbar.
+ *
+ * @Returns: GType of #HildonFindToolbar
+ */
 GType G_GNUC_CONST
 hildon_find_toolbar_get_type                    (void)
 {
@@ -527,35 +534,66 @@ hildon_find_toolbar_class_init                  (HildonFindToolbarClass *klass)
 
     klass->history_append = (gpointer) hildon_find_toolbar_history_append;
 
-    g_object_class_install_property(object_class, PROP_LABEL, 
-            g_param_spec_string("label", 
+    /**
+     * HildonFindToolbar:label:
+     *
+     * The label to display before the search box.
+     *                      
+     */
+    g_object_class_install_property (object_class, PROP_LABEL, 
+            g_param_spec_string ("label", 
                 "Label", "Displayed name for"
                 " find-toolbar",
                 _("ecdg_ti_find_toolbar_label"),
                 G_PARAM_READWRITE |
                 G_PARAM_CONSTRUCT));
 
-    g_object_class_install_property(object_class, PROP_PREFIX, 
-            g_param_spec_string("prefix", 
+    /**
+     * HildonFindToolbar:label:
+     *
+     * The label to display before the search box.
+     *                      
+     */
+    g_object_class_install_property (object_class, PROP_PREFIX, 
+            g_param_spec_string ("prefix", 
                 "Prefix", "Search string", NULL,
                 G_PARAM_READWRITE));
 
-    g_object_class_install_property(object_class, PROP_LIST,
-            g_param_spec_object("list",
+    /**
+     * HildonFindToolbar:list:
+     *
+     * A #GtkListStore where the search history is kept.
+     *                      
+     */
+    g_object_class_install_property (object_class, PROP_LIST,
+            g_param_spec_object ("list",
                 "List"," GtkListStore model where "
                 "history list is kept",
                 GTK_TYPE_LIST_STORE,
                 G_PARAM_READWRITE));
 
+    /**
+     * HildonFindToolbar:column:
+     *
+     * The column number in GtkListStore where strings of
+     * search history are kept.
+     *                      
+     */
     g_object_class_install_property(object_class, PROP_COLUMN,
-            g_param_spec_int("column",
+            g_param_spec_int ("column",
                 "Column", "Column number in GtkListStore "
                 "where history list strings are kept",
                 0, G_MAXINT,
                 0, G_PARAM_READWRITE));
 
-    g_object_class_install_property(object_class, PROP_MAX,
-            g_param_spec_int("max_characters",
+    /**
+     * HildonFindToolbar:label:
+     *
+     * The label to display before the search box.
+     *                      
+     */
+    g_object_class_install_property (object_class, PROP_MAX,
+            g_param_spec_int ("max_characters",
                 "Maximum number of characters",
                 "Maximum number of characters "
                 "in search string",
@@ -563,8 +601,14 @@ hildon_find_toolbar_class_init                  (HildonFindToolbarClass *klass)
                 0, G_PARAM_READWRITE |
                 G_PARAM_CONSTRUCT));
 
-    g_object_class_install_property(object_class, PROP_HISTORY_LIMIT,
-            g_param_spec_int("history_limit",
+    /**
+     * HildonFindToolbar:history-limit:
+     *
+     * Maximum number of history items in the combobox.
+     *                      
+     */
+    g_object_class_install_property (object_class, PROP_HISTORY_LIMIT,
+            g_param_spec_int ("history-limit",
                 "Maximum number of history items",
                 "Maximum number of history items "
                 "in search combobox",
@@ -708,11 +752,10 @@ hildon_find_toolbar_init                        (HildonFindToolbar *self)
  * @label: label for the find_toolbar, NULL to set the label to 
  *         default "Find"
  * 
- * Returns a new HildonFindToolbar.
+ * Creates a new HildonFindToolbar.
  *
  * Returns: a new HildonFindToolbar
  */
-
 GtkWidget*
 hildon_find_toolbar_new                         (const gchar *label)
 {
@@ -727,14 +770,14 @@ hildon_find_toolbar_new                         (const gchar *label)
 }
 
 /**
- * hildon_find_toolbar_new_with_model
+ * hildon_find_toolbar_new_with_model:
  * @label: label for the find_toolbar, NULL to set the label to 
  *         default "Find"
  * @model: a @GtkListStore
  * @column: indicating which column the search histry list will 
  *          retreive string from
  * 
- * Returns a new HildonFindToolbar, with a model.
+ * Creates a new HildonFindToolbar with a model.
  *
  * Returns: a new #HildonFindToolbar
  */
@@ -753,10 +796,12 @@ hildon_find_toolbar_new_with_model              (const gchar *label,
 }
 
 /**
- * hildon_find_toolbar_highlight_entry
+ * hildon_find_toolbar_highlight_entry:
  * @ftb: find Toolbar whose entry is to be highlighted
  * @get_focus: if user passes TRUE to this value, then the text in
  * the entry will not only get highlighted, but also get focused.
+ *
+ * Highlights the current entry in the find toolbar.
  * 
  */
 void
@@ -774,7 +819,7 @@ hildon_find_toolbar_highlight_entry             (HildonFindToolbar *self,
 
     gtk_editable_select_region (GTK_EDITABLE (entry), 0, -1);
 
-    if(get_focus)
+    if (get_focus)
         gtk_widget_grab_focus (GTK_WIDGET (entry));
 }
 

diff --git a/src/hildon-font-selection-dialog.c b/src/hildon-font-selection-dialog.c
index a675c89..edd6375 100644 (file)
--- a/src/hildon-font-selection-dialog.c
+++ b/src/hildon-font-selection-dialog.c
@@ -170,6 +170,13 @@ static GtkDialogClass*                          parent_class = NULL;
 
 #define                                         OFF_BIT 0x02
 
+/**
+ * hildon_font_selection_dialog_get_type:
+ *
+ * Initializes and returns the type of a hildon font selection dialog
+ *
+ * @Returns: GType of #HildonFontSelectionDialog
+ */
 GType G_GNUC_CONST
 hildon_font_selection_dialog_get_type           (void)
 {
@@ -518,13 +525,24 @@ hildon_font_selection_dialog_class_init         (HildonFontSelectionDialogClass
     gobject_class->get_property     = hildon_font_selection_dialog_get_property;
     gobject_class->set_property     = hildon_font_selection_dialog_set_property;
 
-    /* Install property to the class */
+    /* Install properties to the class */
+
+    /**
+     * HildonFontSelectionDialog:family:
+     *
+     * Font family used.
+     */
     g_object_class_install_property (gobject_class, PROP_FAMILY,
             g_param_spec_string ("family",
                 "Font family", "String defines"
                 " the font family", "Sans",
                 G_PARAM_READWRITE));
 
+    /**
+     * HildonFontSelectionDialog:family-set:
+     *
+     * Is font family set or inconsistent.
+     */
     g_object_class_install_property (gobject_class, PROP_FAMILY_SET,
             g_param_spec_boolean ("family-set",
                 "family inconsistent state",
@@ -532,6 +550,11 @@ hildon_font_selection_dialog_class_init         (HildonFontSelectionDialogClass
                 " is inconsistent", FALSE,
                 G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
 
+    /**
+     * HildonFontSelectionDialog:size:
+     *
+     * Font size.
+     */
     g_object_class_install_property (gobject_class, PROP_SIZE,
             g_param_spec_int ("size",
                 "Font size",
@@ -539,6 +562,11 @@ hildon_font_selection_dialog_class_init         (HildonFontSelectionDialogClass
                 6, 32, 16,
                 G_PARAM_READWRITE));
 
+    /**
+     * HildonFontSelectionDialog:size-set:
+     *
+     * Is font size set or inconsistent.
+     */
     g_object_class_install_property (gobject_class, PROP_SIZE_SET,
             g_param_spec_boolean ("size-set",
                 "size inconsistent state",
@@ -546,6 +574,11 @@ hildon_font_selection_dialog_class_init         (HildonFontSelectionDialogClass
                 " is inconsistent", FALSE,
                 G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
 
+    /**
+     * HildonFontSelectionDialog:color:
+     *
+     * GdkColor for the text.
+     */
     g_object_class_install_property (gobject_class, PROP_COLOR,
             g_param_spec_boxed ("color",
                 "text color",
@@ -553,6 +586,11 @@ hildon_font_selection_dialog_class_init         (HildonFontSelectionDialogClass
                 GDK_TYPE_COLOR,
                 G_PARAM_READWRITE));
 
+    /**
+     * HildonFontSelectionDialog:color-set:
+     *
+     * Is font color set or inconsistent.
+     */
     g_object_class_install_property (gobject_class, PROP_COLOR_SET,
             g_param_spec_boolean ("color-set",
                 "color inconsistent state",
@@ -560,6 +598,11 @@ hildon_font_selection_dialog_class_init         (HildonFontSelectionDialogClass
                 " is inconsistent", FALSE,
                 G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
 
+    /**
+     * HildonFontSelectionDialog:color-set:
+     *
+     * Is font set as bold.
+     */
     g_object_class_install_property (gobject_class, PROP_BOLD,
             g_param_spec_boolean ("bold",
                 "text weight",
@@ -567,6 +610,11 @@ hildon_font_selection_dialog_class_init         (HildonFontSelectionDialogClass
                 FALSE,
                 G_PARAM_READWRITE));
 
+    /**
+     * HildonFontSelectionDialog:color-set:
+     *
+     * Is font bold status set or inconsistent.
+     */
     g_object_class_install_property (gobject_class, PROP_BOLD_SET,
             g_param_spec_boolean ("bold-set",
                 "bold inconsistent state",
@@ -574,6 +622,11 @@ hildon_font_selection_dialog_class_init         (HildonFontSelectionDialogClass
                 " is inconsistent", FALSE,
                 G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
 
+    /**
+     * HildonFontSelectionDialog:italic:
+     *
+     * Is font set as italic.
+     */
     g_object_class_install_property (gobject_class, PROP_ITALIC,
             g_param_spec_boolean ("italic",
                 "text style",
@@ -581,6 +634,11 @@ hildon_font_selection_dialog_class_init         (HildonFontSelectionDialogClass
                 FALSE,
                 G_PARAM_READWRITE));
 
+    /**
+     * HildonFontSelectionDialog:italic-set:
+     *
+     * Is font italic status set or inconsistent.
+     */
     g_object_class_install_property (gobject_class, PROP_ITALIC_SET,
             g_param_spec_boolean ("italic-set",
                 "italic inconsistent state",
@@ -588,6 +646,11 @@ hildon_font_selection_dialog_class_init         (HildonFontSelectionDialogClass
                 " is inconsistent", FALSE,
                 G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
 
+    /**
+     * HildonFontSelectionDialog:underline:
+     *
+     * Is the font underlined.
+     */
     g_object_class_install_property (gobject_class, PROP_UNDERLINE,
             g_param_spec_boolean ("underline",
                 "text underline",
@@ -595,6 +658,11 @@ hildon_font_selection_dialog_class_init         (HildonFontSelectionDialogClass
                 FALSE,
                 G_PARAM_READWRITE));
 
+    /**
+     * HildonFontSelectionDialog:underline:
+     *
+     * Is font underline status set or inconsistent.
+     */
     g_object_class_install_property (gobject_class, PROP_UNDERLINE_SET,
             g_param_spec_boolean ("underline-set",
                 "underline inconsistent state",
@@ -602,6 +670,11 @@ hildon_font_selection_dialog_class_init         (HildonFontSelectionDialogClass
                 " is inconsistent", FALSE,
                 G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
 
+    /**
+     * HildonFontSelectionDialog:strikethrough:
+     *
+     * Is the font striken-through.
+     */
     g_object_class_install_property (gobject_class, PROP_STRIKETHROUGH,
             g_param_spec_boolean ("strikethrough",
                 "strikethroughed text",
@@ -609,6 +682,11 @@ hildon_font_selection_dialog_class_init         (HildonFontSelectionDialogClass
                 FALSE,
                 G_PARAM_READWRITE));
 
+    /**
+     * HildonFontSelectionDialog:strikethrough-set:
+     *
+     * Is the font strikenthrough status set.
+     */
     g_object_class_install_property (gobject_class, PROP_STRIKETHROUGH_SET,
             g_param_spec_boolean ("strikethrough-set",
                 "strikethrough inconsistent state",
@@ -616,6 +694,11 @@ hildon_font_selection_dialog_class_init         (HildonFontSelectionDialogClass
                 " is inconsistent", FALSE,
                 G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
 
+    /**
+     * HildonFontSelectionDialog:position:
+     *
+     * The font positioning versus baseline.
+     */
     g_object_class_install_property (gobject_class, PROP_POSITION,
             g_param_spec_int ("position",
                 "Font position",
@@ -623,13 +706,11 @@ hildon_font_selection_dialog_class_init         (HildonFontSelectionDialogClass
                 -1, 1, 0,
                 G_PARAM_READWRITE));
 
-    g_object_class_install_property (gobject_class, PROP_FONT_SCALING,
-            g_param_spec_double ("font-scaling",
-                "Font scaling",
-                "Font scaling for the preview dialog",
-                0, 10, 1,
-                G_PARAM_READWRITE));
-
+    /**
+     * HildonFontSelectionDialog:position-set:
+     *
+     * Is the font positioning set.
+     */
     g_object_class_install_property (gobject_class, PROP_POSITION_SET,
             g_param_spec_boolean ("position-set",
                 "position inconsistent state",
@@ -637,6 +718,23 @@ hildon_font_selection_dialog_class_init         (HildonFontSelectionDialogClass
                 " is inconsistent", FALSE,
                 G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
 
+    /**
+     * HildonFontSelectionDialog:font-scaling:
+     *
+     * The font scaling factor applied to the preview dialog.
+     */
+    g_object_class_install_property (gobject_class, PROP_FONT_SCALING,
+            g_param_spec_double ("font-scaling",
+                "Font scaling",
+                "Font scaling for the preview dialog",
+                0, 10, 1,
+                G_PARAM_READWRITE));
+
+    /**
+     * HildonFontSelectionDialog:preview-text:
+     *
+     * The text used for the preview dialog.
+     */
     g_object_class_install_property (gobject_class, PROP_PREVIEW_TEXT,
             g_param_spec_string("preview-text",
                 "Preview Text", 
@@ -645,7 +743,8 @@ hildon_font_selection_dialog_class_init         (HildonFontSelectionDialogClass
                 "",
                 G_PARAM_READWRITE));
 
-    g_type_class_add_private (klass, sizeof(struct _HildonFontSelectionDialogPrivate));
+    g_type_class_add_private (klass, 
+            sizeof (struct _HildonFontSelectionDialogPrivate));
 }
 
 static void 
@@ -1110,7 +1209,6 @@ hildon_font_selection_dialog_show_preview       (HildonFontSelectionDialog *font
     gtk_widget_destroy (preview_dialog);
 }
 
-
 static gboolean 
 is_internal_font                                (const gchar * name)
 {
@@ -1254,8 +1352,8 @@ hildon_font_selection_dialog_new                (GtkWindow *parent,
  *
  * Returns: a string pointer
  */
-gchar *
-hildon_font_selection_dialog_get_preview_text(HildonFontSelectionDialog * fsd)
+gchar*
+hildon_font_selection_dialog_get_preview_text   (HildonFontSelectionDialog * fsd)
 {
     /* FIXME Return a const pointer? */
     HildonFontSelectionDialogPrivate *priv;