Documented EphyEmbedSingle

5 files changed, 117 insertions, 36 deletions

diff --git a/doc/reference/epiphany-docs.sgml b/doc/reference/epiphany-docs.sgml
index 92185ba87..aa8abfa73 100644
--- a/doc/reference/epiphany-docs.sgml
+++ b/doc/reference/epiphany-docs.sgml
@@ -12,10 +12,10 @@
     <xi:include href="xml/ephy-window.xml"/>
     <xi:include href="xml/ephy-tab.xml"/>
     <xi:include href="xml/ephy-embed.xml"/>
+    <xi:include href="xml/ephy-embed-single.xml"/>
   </chapter>
   <chapter>
     <title>Incomplete</title>
-    <xi:include href="xml/ephy-embed-single.xml"/>
     <xi:include href="xml/ephy-cookie-manager.xml"/>
     <xi:include href="xml/ephy-password-manager.xml"/>
     <xi:include href="xml/ephy-session.xml"/>
diff --git a/doc/reference/epiphany-sections.txt b/doc/reference/epiphany-sections.txt
index 5d6d8bda3..3cb40f04e 100644
--- a/doc/reference/epiphany-sections.txt
+++ b/doc/reference/epiphany-sections.txt
@@ -132,6 +132,24 @@ EPHY_IS_EMBED_IFACE
 EPHY_TYPE_EMBED_CHROME_MASK
 </SECTION>
 
+<SECTION>
+<FILE>ephy-embed-single</FILE>
+<TITLE>EphyEmbedSingle</TITLE>
+ephy_embed_single_clear_cache
+ephy_embed_single_clear_auth_cache
+ephy_embed_single_set_offline_mode
+ephy_embed_single_load_proxy_autoconf
+ephy_embed_single_get_font_list
+<SUBSECTION Standard>
+EPHY_EMBED_SINGLE
+EPHY_IS_EMBED_SINGLE
+EPHY_TYPE_EMBED_SINGLE
+ephy_embed_single_get_type
+EPHY_EMBED_SINGLE_GET_IFACE
+EPHY_EMBED_SINGLE_IFACE
+EPHY_IS_EMBED_SINGLE_IFACE
+</SECTION>
+
 
 
 
@@ -231,23 +249,6 @@ EPHY_COOKIE_MANAGER_GET_IFACE
 </SECTION>
 
 <SECTION>
-<FILE>ephy-embed-single</FILE>
-EPHY_EMBED_SINGLE_IFACE
-EPHY_IS_EMBED_SINGLE_IFACE
-ephy_embed_single_clear_cache
-ephy_embed_single_clear_auth_cache
-ephy_embed_single_set_offline_mode
-ephy_embed_single_load_proxy_autoconf
-ephy_embed_single_get_font_list
-<SUBSECTION Standard>
-EPHY_EMBED_SINGLE
-EPHY_IS_EMBED_SINGLE
-EPHY_TYPE_EMBED_SINGLE
-ephy_embed_single_get_type
-EPHY_EMBED_SINGLE_GET_IFACE
-</SECTION>
-
-<SECTION>
 <FILE>ephy-embed-factory</FILE>
 ephy_embed_factory_new_object
 </SECTION>
diff --git a/doc/reference/tmpl/ephy-embed-single.sgml b/doc/reference/tmpl/ephy-embed-single.sgml
index 29899db97..3368ee788 100644
--- a/doc/reference/tmpl/ephy-embed-single.sgml
+++ b/doc/reference/tmpl/ephy-embed-single.sgml
@@ -1,40 +1,47 @@
 <!-- ##### SECTION Title ##### -->
-ephy-embed-single
+EphyEmbedSingle
 
 <!-- ##### SECTION Short_Description ##### -->
-
+An interface to the global embedded browser
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+While Epiphany is running, its global embed_shell variable (an #EphyEmbedShell)
+holds a reference to an #EphyEmbedSingle. The only class which implements
+#EphyEmbedSingle is #MozillaEmbedSingle, so the two types are interchangeable
+via casting.
 </para>
-
-<!-- ##### SECTION See_Also ##### -->
 <para>
+<example>
+<title>Acquiring an <structname>EphyEmbedSingle</structname></title>
+<programlisting>#<![CDATA[include <ephy-embed-shell.h>]]>
+#<![CDATA[include <ephy-embed-single.h>
 
-</para>
+EphyEmbedSingle *ephy_single;
 
-<!-- ##### MACRO EPHY_EMBED_SINGLE_IFACE ##### -->
+/* embed_shell is a global variable, initialized as Epiphany starts */
+ephy_single = ephy_embed_shell_get_embed_single (embed_shell);
+]]></programlisting>
+</example>
+</para>
 <para>
-
+Since there is only one #EphyEmbedShell, there is only one #EphyEmbedSingle. It
+is used to perform browser-related actions which do not refer to an individual
+#EphyEmbed.
 </para>
 
-@k: 
-
-
-<!-- ##### MACRO EPHY_IS_EMBED_SINGLE_IFACE ##### -->
+<!-- ##### SECTION See_Also ##### -->
 <para>
 
 </para>
 
-@k: 
-
-
 <!-- ##### FUNCTION ephy_embed_single_clear_cache ##### -->
 <para>
 
 </para>
 
+@single: 
+<!-- # Unused Parameters # -->
 @shell: 
 
 
@@ -43,6 +50,8 @@ ephy-embed-single
 
 </para>
 
+@single: 
+<!-- # Unused Parameters # -->
 @shell: 
 
 
@@ -51,8 +60,10 @@ ephy-embed-single
 
 </para>
 
-@shell: 
+@single: 
 @offline: 
+<!-- # Unused Parameters # -->
+@shell: 
 
 
 <!-- ##### FUNCTION ephy_embed_single_load_proxy_autoconf ##### -->
@@ -60,8 +71,10 @@ ephy-embed-single
 
 </para>
 
-@shell: 
+@single: 
 @url: 
+<!-- # Unused Parameters # -->
+@shell: 
 
 
 <!-- ##### FUNCTION ephy_embed_single_get_font_list ##### -->
@@ -69,8 +82,11 @@ ephy-embed-single
 
 </para>
 
+@single: 
+@lang_group: 
+@Returns: 
+<!-- # Unused Parameters # -->
 @shell: 
 @langGroup: 
-@Returns: 
 
 
diff --git a/doc/reference/tmpl/ephy-tab.sgml b/doc/reference/tmpl/ephy-tab.sgml
index 94d71bb1f..ae5eba7b0 100644
--- a/doc/reference/tmpl/ephy-tab.sgml
+++ b/doc/reference/tmpl/ephy-tab.sgml
@@ -128,3 +128,53 @@ An #EphyTab is basically a container for an #EphyEmbed.
 @Returns: 
 
 
+<!-- ##### ARG EphyTab:address ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EphyTab:icon ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EphyTab:load-progress ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EphyTab:load-status ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EphyTab:message ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EphyTab:navigation ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EphyTab:security-level ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EphyTab:title ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EphyTab:visible ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EphyTab:zoom ##### -->
+<para>
+
+</para>
+
diff --git a/doc/reference/tmpl/epiphany-unused.sgml b/doc/reference/tmpl/epiphany-unused.sgml
index 5fcda58b0..2932d9274 100644
--- a/doc/reference/tmpl/epiphany-unused.sgml
+++ b/doc/reference/tmpl/epiphany-unused.sgml
@@ -18,6 +18,20 @@
 mozilla-embed-event
 
 
+<!-- ##### MACRO EPHY_EMBED_SINGLE_IFACE ##### -->
+<para>
+
+</para>
+
+@k: 
+
+<!-- ##### MACRO EPHY_IS_EMBED_SINGLE_IFACE ##### -->
+<para>
+
+</para>
+
+@k: 
+
 <!-- ##### MACRO EPHY_SHELL_TYPE_DEF ##### -->
 <para>