Changeset 3020

Timestamp:

09/20/07 16:00:55 (6 years ago)

Author:

thomas

Message:

• libmokoui/moko-search-bar.c: (moko_search_bar_init),

(moko_search_bar_new), (moko_search_bar_new_with_combo),
(moko_search_bar_get_combo_box), (moko_search_bar_get_entry),
(moko_search_bar_search_visible):

Add documentation for MokoSearchBar?

Location:

trunk/src/target/OM-2007.2/libraries/libmokoui2

Files:

• ChangeLog (modified) (1 diff)
• libmokoui/moko-search-bar.c (modified) (6 diffs)

trunk/src/target/OM-2007.2/libraries/libmokoui2/ChangeLog

@@ +1 @@
+2007-09-20  Thomas Wood  <thomas@openedhand.com>
+
+        * libmokoui/moko-search-bar.c: (moko_search_bar_init),
+        (moko_search_bar_new), (moko_search_bar_new_with_combo),
+        (moko_search_bar_get_combo_box), (moko_search_bar_get_entry),
+        (moko_search_bar_search_visible):
+
+        Add documentation for MokoSearchBar
+
 2007-09-20  Thomas Wood  <thomas@openedhand.com>
 

trunk/src/target/OM-2007.2/libraries/libmokoui2/libmokoui/moko-search-bar.c

@@ -218 +218 @@
 }
 
+/**
+ * moko_search_bar_new:
+ *
+ * Create a new MokoSearBar widget
+ *
+ * returns: The newly created MokoSearchBar
+ */
+
 GtkWidget *
 moko_search_bar_new (void)
@@ -225 +233 @@
 }
 
+/**
+ * moko_search_bar_new_with_combo:
+ * @comno: a GtkComboBox to use as the combobox
+ *
+ * Creates a MokoSearchBar with the specified combo box
+ *
+ * returns: the newly created MokoSearchBar
+ */
+
 GtkWidget *
 moko_search_bar_new_with_combo (GtkComboBox *combo)
@@ -232 +249 @@
 }
 
+/**
+ * moko_search_bar_get_combo_box:
+ * @self: a MokoSearchBar
+ *
+ * Get a pointer to the GtkComboBox being used in the MokoSearchBar
+ *
+ * returns: the GtkComboBox
+ */
 GtkComboBox *
 moko_search_bar_get_combo_box (MokoSearchBar *self)
@@ -240 +265 @@
 }
 
+
+/**
+ * moko_search_bar_get_entry:
+ * @self: a MokoSearchBar
+ *
+ * Retrieve the GtkEntry widget being used in the MokoSearchBar
+ *
+ * returns: the GtkEntry
+ */
 GtkEntry *
 moko_search_bar_get_entry (MokoSearchBar *self)
@@ -248 +282 @@
 }
 
+/**
+ * moko_search_bar_search_visible:
+ * @self: a MokoSaerchBar
+ *
+ * Determine the visibility of the search entry.
+ *
+ * returns: TRUE if the search entry is visible
+ */
 gboolean
 moko_search_bar_search_visible (MokoSearchBar *self)
@@ -256 +298 @@
 }
 
+
+/**
+ * moko_search_bar_toggle:
+ * @self: a MokoSearchBar
+ *
+ * Toggle the search button on the MokoSearchBar.
+ * This toggles the visibility of the combo box and entry widgets.
+ */
 void
 moko_search_bar_toggle (MokoSearchBar *self)