epiphany r8555 - trunk/lib/widgets

[diegoe svn gnome org]

Author: diegoe
Date: Mon Sep 29 05:53:25 2008
New Revision: 8555
URL: http://svn.gnome.org/viewvc/epiphany?rev=8555&view=rev

Log:
Document lib/widgets/ephy-icon-entry.c

Functions ephy_icon_entry_pack_widget and ephy_icon_entry_get_entry. Not sure
how to extract that to proper gtk-docs and stuff.

Document lib/widgets/ephy-search-entry.c

Modified:
   trunk/lib/widgets/ephy-icon-entry.c
   trunk/lib/widgets/ephy-search-entry.c

Modified: trunk/lib/widgets/ephy-icon-entry.c
==============================================================================
--- trunk/lib/widgets/ephy-icon-entry.c	(original)
+++ trunk/lib/widgets/ephy-icon-entry.c	Mon Sep 29 05:53:25 2008
@@ -319,6 +319,16 @@
 	return GTK_WIDGET (g_object_new (EPHY_TYPE_ICON_ENTRY, NULL));
 }
 
+/*
+ * ephy_icon_entry_pack_widget:
+ * @entry: an #EphyIconEntry
+ * @widget: a #GtkWidget to pack into the entry
+ * @start: wheter we should use gtk_box_pack_start or gtk_box_pack_end
+ *
+ * Packs a widget into an #EphyIconEntry, the @start parameter determines if
+ * it's packed at the start or end of it.
+ *
+ */
 void
 ephy_icon_entry_pack_widget (EphyIconEntry *entry,
 			     GtkWidget *widget,
@@ -341,6 +351,15 @@
 	}
 }
 
+/*
+ * ephy_icon_entry_get_entry:
+ * @entry: an #EphyIconEntry
+ *
+ * Returns the #GtkEntry inside @entry.
+ *
+ * Return value: the embedded #GtkEntry
+ *
+ */
 GtkWidget *
 ephy_icon_entry_get_entry (EphyIconEntry *entry)
 {

Modified: trunk/lib/widgets/ephy-search-entry.c
==============================================================================
--- trunk/lib/widgets/ephy-search-entry.c	(original)
+++ trunk/lib/widgets/ephy-search-entry.c	Mon Sep 29 05:53:25 2008
@@ -155,6 +155,13 @@
 			  entry);
 }
 
+/*
+ * ephy_search_entry_new:
+ *
+ * Creates a new #EphySearchEntry.
+ *
+ * Returns: a new #EphySearchEntry, as a #GtkWidget
+ */
 GtkWidget *
 ephy_search_entry_new (void)
 {
@@ -166,6 +173,13 @@
 	return entry;
 }
 
+/*
+ * ephy_search_entry_clear:
+ * @entry: an #EphySearchEntry
+ *
+ * Clears the text of the internal #GtkEntry of @entry.
+ *
+ */
 void
 ephy_search_entry_clear (EphySearchEntry *entry)
 {