[epiphany/origin/master: 6/19] docs: ephy-zoom-action

[Diego Escalante Urrelo <diegoe src gnome org>]

commit 8d6415811078b018c36a581144338d65342e2f8b
Author: Diego Escalante Urrelo <diegoe gnome org>
Date:   Tue Dec 1 14:25:39 2009 -0500

    docs: ephy-zoom-action

 doc/reference/Makefile.am           |    1 -
 doc/reference/epiphany-docs.sgml    |    1 +
 doc/reference/epiphany-sections.txt |    8 ++++++++
 lib/widgets/ephy-zoom-action.c      |   34 ++++++++++++++++++++++++++++++++++
 4 files changed, 43 insertions(+), 1 deletions(-)
---
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index af19d42..b64af9c 100644
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -53,7 +53,6 @@ IGNORE_HFILES = \
 	ephy-node-view.h \
 	ephy-tree-model-node.h \
 	ephy-tree-model-sort.h \
-	ephy-zoom-action.h \
 	downloader-view.h \
 	ephy-embed-dialog.h \
 	ephy-embed-event.h \
diff --git a/doc/reference/epiphany-docs.sgml b/doc/reference/epiphany-docs.sgml
index ab04801..01d9c7c 100644
--- a/doc/reference/epiphany-docs.sgml
+++ b/doc/reference/epiphany-docs.sgml
@@ -23,6 +23,7 @@
     <xi:include href="xml/ephy-location-entry.xml"/>
     <xi:include href="xml/ephy-search-entry.xml"/>
     <xi:include href="xml/ephy-spinner.xml"/>
+    <xi:include href="xml/ephy-zoom-action.xml"/>
     <xi:include href="xml/ephy-zoom-control.xml"/>
   </chapter>
   <chapter>
diff --git a/doc/reference/epiphany-sections.txt b/doc/reference/epiphany-sections.txt
index 6e20466..61fe4cc 100644
--- a/doc/reference/epiphany-sections.txt
+++ b/doc/reference/epiphany-sections.txt
@@ -320,3 +320,11 @@ ephy_spinner_start
 ephy_spinner_stop
 ephy_spinner_set_size
 </SECTION>
+
+<SECTION>
+<FILE>ephy-zoom-action</FILE>
+<TITLE>EphyZoomAction</TITLE>
+EphyZoomAction
+ephy_zoom_action_set_zoom_level
+ephy_zoom_action_get_zoom_level
+</SECTION>
diff --git a/lib/widgets/ephy-zoom-action.c b/lib/widgets/ephy-zoom-action.c
index 577a4fc..0d42b9c 100644
--- a/lib/widgets/ephy-zoom-action.c
+++ b/lib/widgets/ephy-zoom-action.c
@@ -26,6 +26,13 @@
 #include "ephy-zoom-control.h"
 #include "ephy-zoom.h"
 
+/**
+ * SECTION:ephy-zoom-action
+ * @short_description: A #GtkAction implementing a zoom control
+ *
+ * #EphyZoomAction implements a #GtkAction able to control the zoom level.
+ */
+
 #define EPHY_ZOOM_ACTION_GET_PRIVATE(object)(G_TYPE_INSTANCE_GET_PRIVATE ((object), EPHY_TYPE_ZOOM_ACTION, EphyZoomActionPrivate))
 
 struct _EphyZoomActionPrivate
@@ -192,6 +199,11 @@ ephy_zoom_action_class_init (EphyZoomActionClass *class)
 	action_class->connect_proxy = connect_proxy;
 	action_class->create_menu_item = create_menu_item;
 
+	/**
+	* EphyZoomAction:zoom:
+	*
+	* The current value of #EphyZoomAction, as a float.
+	*/
 	g_object_class_install_property (object_class,
 					 PROP_ZOOM,
 					 g_param_spec_float ("zoom", NULL, NULL,
@@ -200,6 +212,13 @@ ephy_zoom_action_class_init (EphyZoomActionClass *class)
 							     1.0,
 							     G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB));
 
+	/**
+	* EphyZoomAction::zoom-to-level:
+	* @action: the object on which the signal is emitted
+	* @level: new zoom level
+	*
+	* Emitted when the user changes the value of the #EphyZoomAction.
+	*/
 	signals[ZOOM_TO_LEVEL_SIGNAL] =
 		g_signal_new ("zoom-to-level",
 			      G_OBJECT_CLASS_TYPE (object_class),
@@ -222,6 +241,13 @@ ephy_zoom_action_init (EphyZoomAction *action)
 	action->priv->zoom = 1.0;
 }
 
+/**
+ * ephy_zoom_action_set_zoom_level:
+ * @action: an #EphyZoomAction
+ * @zoom: the new value for the zoom level
+ *
+ * Sets the zoom level of @action.
+ **/
 void
 ephy_zoom_action_set_zoom_level (EphyZoomAction *action, float zoom)
 {
@@ -233,6 +259,14 @@ ephy_zoom_action_set_zoom_level (EphyZoomAction *action, float zoom)
 	g_object_notify (G_OBJECT (action), "zoom");
 }
 
+/**
+ * ephy_zoom_action_get_zoom_level:
+ * @action: an #EphyZoomControl
+ *
+ * Get the current zoom level of @action.
+ *
+ * Returns: the zoom level as a float
+ **/
 float
 ephy_zoom_action_get_zoom_level (EphyZoomAction *action)
 {