From 9edd54c2d241a6c3a3a5d46ca68520ecc92c57f5 Mon Sep 17 00:00:00 2001
From: Diego Escalante Urrelo <diegoe@src.gnome.org>
Date: Mon, 29 Sep 2008 05:53:25 +0000
Subject: 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

svn path=/trunk/; revision=8555
---
 lib/widgets/ephy-icon-entry.c   | 19 +++++++++++++++++++
 lib/widgets/ephy-search-entry.c | 14 ++++++++++++++
 2 files changed, 33 insertions(+)

(limited to 'lib')

diff --git a/lib/widgets/ephy-icon-entry.c b/lib/widgets/ephy-icon-entry.c
index 0cb159689..6224076d5 100644
--- a/lib/widgets/ephy-icon-entry.c
+++ b/lib/widgets/ephy-icon-entry.c
@@ -319,6 +319,16 @@ ephy_icon_entry_new (void)
 	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_pack_widget (EphyIconEntry *entry,
 	}
 }
 
+/*
+ * 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)
 {
diff --git a/lib/widgets/ephy-search-entry.c b/lib/widgets/ephy-search-entry.c
index 80bd3af0c..73754c643 100644
--- a/lib/widgets/ephy-search-entry.c
+++ b/lib/widgets/ephy-search-entry.c
@@ -155,6 +155,13 @@ ephy_search_entry_init (EphySearchEntry *entry)
 			  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 @@ ephy_search_entry_new (void)
 	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)
 {
-- 
cgit v1.2.3