[epiphany/origin/master: 15/19] docs: ephy-statusbar

[Diego Escalante Urrelo <diegoe src gnome org>]

commit deac403a8eb8f1ad00333b47f6c0df448110972e
Author: Diego Escalante Urrelo <diegoe gnome org>
Date:   Tue Dec 1 22:03:11 2009 -0500

    docs: ephy-statusbar
    
    Bug #503852

 doc/reference/Makefile.am           |    1 -
 doc/reference/epiphany-docs.sgml    |    1 +
 doc/reference/epiphany-sections.txt |   13 +++++++++++++
 doc/reference/epiphany.types        |    2 ++
 src/ephy-statusbar.c                |   16 +++++++++++++++-
 5 files changed, 31 insertions(+), 2 deletions(-)
---
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index 13232a3..5a8ffeb 100644
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -92,7 +92,6 @@ IGNORE_HFILES = \
 	ephy-location-action.h \
 	ephy-navigation-action.h \
 	ephy-notebook.h \
-	ephy-statusbar.h \
 	ephy-tabs-menu.h \
 	ephy-toolbars-model.h \
 	pdm-dialog.h \
diff --git a/doc/reference/epiphany-docs.sgml b/doc/reference/epiphany-docs.sgml
index 8566550..f916702 100644
--- a/doc/reference/epiphany-docs.sgml
+++ b/doc/reference/epiphany-docs.sgml
@@ -8,6 +8,7 @@
 
   <chapter>
     <title>Epiphany</title>
+    <xi:include href="xml/ephy-statusbar.xml"/>
     <xi:include href="xml/ephy-window.xml"/>
   </chapter>
   <chapter>
diff --git a/doc/reference/epiphany-sections.txt b/doc/reference/epiphany-sections.txt
index 511c2f8..b389f15 100644
--- a/doc/reference/epiphany-sections.txt
+++ b/doc/reference/epiphany-sections.txt
@@ -96,6 +96,19 @@ ephy_zoom_control_get_zoom_level
 </SECTION>
 
 <SECTION>
+<FILE>ephy-statusbar</FILE>
+<TITLE>EphyStatusbar</TITLE>
+EphyStatusbar
+ephy_statusbar_new
+ephy_statusbar_get_security_frame
+ephy_statusbar_set_caret_mode
+ephy_statusbar_set_security_state
+ephy_statusbar_set_popups_state
+ephy_statusbar_add_widget
+ephy_statusbar_remove_widget
+</SECTION>
+
+<SECTION>
 <FILE>ephy-window</FILE>
 <TITLE>EphyWindow</TITLE>
 EphyWindow
diff --git a/doc/reference/epiphany.types b/doc/reference/epiphany.types
index 2e3c6a4..d9e4d16 100644
--- a/doc/reference/epiphany.types
+++ b/doc/reference/epiphany.types
@@ -15,6 +15,8 @@ ephy_tree_model_sort_get_type
 ephy_zoom_action_get_type
 ephy_zoom_control_get_type
 
+#include <ephy-statusbar.h>
 #include <ephy-window.h>
 
+ephy_statusbar_get_type
 ephy_window_get_type
diff --git a/src/ephy-statusbar.c b/src/ephy-statusbar.c
index c3c7abb..af2b234 100644
--- a/src/ephy-statusbar.c
+++ b/src/ephy-statusbar.c
@@ -28,6 +28,13 @@
 #include <glib/gi18n.h>
 #include <gtk/gtk.h>	
 
+/**
+ * SECTION:ephy-statusbar
+ * @short_description: A statusbar widget for Epiphany
+ *
+ * #EphyStatusbar is Epiphany's default statusbar for all windows.
+ */
+
 static void ephy_statusbar_class_init	(EphyStatusbarClass *klass);
 static void ephy_statusbar_init		(EphyStatusbar *t);
 
@@ -60,6 +67,13 @@ ephy_statusbar_class_init (EphyStatusbarClass *klass)
 {
 	GObjectClass *object_class = G_OBJECT_CLASS (klass);
 
+	/**
+	* EphyStatusbar::lock-clicked:
+	* @statusbar: the object which received the signal.
+	*
+	* This signal corresponds to the user clicking on the lock icon on the
+	* @statusbar.
+	*/
 	signals[LOCK_CLICKED] =
 		g_signal_new
 			("lock-clicked",
@@ -197,7 +211,7 @@ ephy_statusbar_new (void)
 /**
  * ephy_statusbar_set_caret_mode:
  * @statusbar: an #EphyStatusbar
- * @enabled:
+ * @enabled: %TRUE to show the caret browsing mode indicator
  * 
  * Sets the statusbar's caret browsing mode indicator.
  **/