epiphany r8622 - in trunk: doc/reference doc/reference/tmpl lib/widgets

[diegoe svn gnome org]

Author: diegoe
Date: Sat Nov 29 20:03:51 2008
New Revision: 8622
URL: http://svn.gnome.org/viewvc/epiphany?rev=8622&view=rev

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

Added:
   trunk/doc/reference/tmpl/ephy-zoom-control.sgml
Modified:
   trunk/doc/reference/Makefile.am
   trunk/doc/reference/epiphany-docs.sgml
   trunk/doc/reference/epiphany-sections.txt
   trunk/doc/reference/tmpl/ephy-embed.sgml
   trunk/lib/widgets/ephy-zoom-control.c

Modified: trunk/doc/reference/Makefile.am
==============================================================================
--- trunk/doc/reference/Makefile.am	(original)
+++ trunk/doc/reference/Makefile.am	Sat Nov 29 20:03:51 2008
@@ -47,7 +47,6 @@
 	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 \

Modified: trunk/doc/reference/epiphany-docs.sgml
==============================================================================
--- trunk/doc/reference/epiphany-docs.sgml	(original)
+++ trunk/doc/reference/epiphany-docs.sgml	Sat Nov 29 20:03:51 2008
@@ -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>

Modified: trunk/doc/reference/epiphany-sections.txt
==============================================================================
--- trunk/doc/reference/epiphany-sections.txt	(original)
+++ trunk/doc/reference/epiphany-sections.txt	Sat Nov 29 20:03:51 2008
@@ -360,3 +360,11 @@
 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>

Modified: trunk/doc/reference/tmpl/ephy-embed.sgml
==============================================================================
--- trunk/doc/reference/tmpl/ephy-embed.sgml	(original)
+++ trunk/doc/reference/tmpl/ephy-embed.sgml	Sat Nov 29 20:03:51 2008
@@ -221,9 +221,6 @@
 @: 
 @: 
 @: 
-@: 
-@: 
-@: 
 @:
 @Param2: 
 

Added: trunk/doc/reference/tmpl/ephy-zoom-control.sgml
==============================================================================
--- (empty file)
+++ trunk/doc/reference/tmpl/ephy-zoom-control.sgml	Sat Nov 29 20:03:51 2008
@@ -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: 
+
+

Modified: trunk/lib/widgets/ephy-zoom-control.c
==============================================================================
--- trunk/lib/widgets/ephy-zoom-control.c	(original)
+++ trunk/lib/widgets/ephy-zoom-control.c	Sat Nov 29 20:03:51 2008
@@ -242,6 +242,14 @@
 	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 @@
 	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)
 {