Document lib/widgets/ephy-zoom-control.c

svn path=/trunk/; revision=8622

6 files changed, 82 insertions, 4 deletions

diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index 0993c5800..46ca8a67c 100644
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -47,7 +47,6 @@ IGNORE_HFILES = \
 	ephy-tree-model-node.h \
 	ephy-tree-model-sort.h \
 	ephy-zoom-action.h \
-	ephy-zoom-control.h \
 	downloader-view.h \
 	ephy-download.h \
 	ephy-embed-dialog.h \
diff --git a/doc/reference/epiphany-docs.sgml b/doc/reference/epiphany-docs.sgml
index 04f4aaf5b..472adf7bc 100644
--- a/doc/reference/epiphany-docs.sgml
+++ b/doc/reference/epiphany-docs.sgml
@@ -25,6 +25,7 @@
     <xi:include href="xml/ephy-icon-entry.xml"/>
     <xi:include href="xml/ephy-location-entry.xml"/>
     <xi:include href="xml/ephy-search-entry.xml"/>
+    <xi:include href="xml/ephy-zoom-control.xml"/>
   </chapter>
   <chapter>
     <title>Incomplete</title>
diff --git a/doc/reference/epiphany-sections.txt b/doc/reference/epiphany-sections.txt
index f58d93c77..ad5960e66 100644
--- a/doc/reference/epiphany-sections.txt
+++ b/doc/reference/epiphany-sections.txt
@@ -360,3 +360,11 @@ EphySearchEntry
 ephy_search_entry_new
 ephy_search_entry_clear
 </SECTION>
+
+<SECTION>
+<FILE>ephy-zoom-control</FILE>
+<TITLE>EphyZoomControl</TITLE>
+EphyZoomControl
+ephy_zoom_control_set_zoom_level
+ephy_zoom_control_get_zoom_level
+</SECTION>
diff --git a/doc/reference/tmpl/ephy-embed.sgml b/doc/reference/tmpl/ephy-embed.sgml
index b4a6db177..8ecca306a 100644
--- a/doc/reference/tmpl/ephy-embed.sgml
+++ b/doc/reference/tmpl/ephy-embed.sgml
@@ -221,9 +221,6 @@ be done by casting).
 @: 
 @: 
 @: 
-@: 
-@: 
-@: 
 @:
 @Param2: 
 
diff --git a/doc/reference/tmpl/ephy-zoom-control.sgml b/doc/reference/tmpl/ephy-zoom-control.sgml
new file mode 100644
index 000000000..fcad1c60a
--- /dev/null
+++ b/doc/reference/tmpl/ephy-zoom-control.sgml
@@ -0,0 +1,56 @@
+<!-- ##### SECTION Title ##### -->
+EphyZoomControl
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT EphyZoomControl ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SIGNAL EphyZoomControl::zoom-to-level ##### -->
+<para>
+
+</para>
+
+@ephyzoomcontrol: the object which received the signal.
+@arg1: 
+
+<!-- ##### ARG EphyZoomControl:zoom ##### -->
+<para>
+
+</para>
+
+<!-- ##### FUNCTION ephy_zoom_control_set_zoom_level ##### -->
+<para>
+
+</para>
+
+@control: 
+@zoom: 
+
+
+<!-- ##### FUNCTION ephy_zoom_control_get_zoom_level ##### -->
+<para>
+
+</para>
+
+@control: 
+@Returns: 
+
+
diff --git a/lib/widgets/ephy-zoom-control.c b/lib/widgets/ephy-zoom-control.c
index 210f2b34a..9229d0b31 100644
--- a/lib/widgets/ephy-zoom-control.c
+++ b/lib/widgets/ephy-zoom-control.c
@@ -242,6 +242,14 @@ ephy_zoom_control_finalize (GObject *o)
 	G_OBJECT_CLASS (parent_class)->finalize (o);
 }
 
+/**
+ * ephy_zoom_control_set_zoom_level:
+ * @control: an #EphyZoomControl
+ * @zoom: the new value for the zoom level
+ *
+ * Sets the zoom level of @control.
+ *
+ **/
 void
 ephy_zoom_control_set_zoom_level (EphyZoomControl *control, float zoom)
 {
@@ -253,6 +261,15 @@ ephy_zoom_control_set_zoom_level (EphyZoomControl *control, float zoom)
 	g_object_notify (G_OBJECT (control), "zoom");
 }
 
+/**
+ * ephy_zoom_control_get_zoom_level:
+ * @control: an #EphyZoomControl
+ *
+ * Get the current zoom level of @control.
+ *
+ * Returns: the zoom level as a float
+ *
+ **/
 float
 ephy_zoom_control_get_zoom_level (EphyZoomControl *control)
 {