From b1a82315dfe5b3c1d8cfb5b33df0d013fc83a87f Mon Sep 17 00:00:00 2001
From: Adam Hooper <adamh@src.gnome.org>
Date: Tue, 30 Mar 2004 12:52:33 +0000
Subject: Documented EphyEmbedFactory

---
 doc/reference/epiphany-docs.sgml           |  2 +-
 doc/reference/epiphany-sections.txt        | 11 ++++++-----
 doc/reference/tmpl/ephy-embed-factory.sgml | 12 +++++++++---
 3 files changed, 16 insertions(+), 9 deletions(-)

(limited to 'doc/reference')

diff --git a/doc/reference/epiphany-docs.sgml b/doc/reference/epiphany-docs.sgml
index 9121ecf77..71605bb0b 100644
--- a/doc/reference/epiphany-docs.sgml
+++ b/doc/reference/epiphany-docs.sgml
@@ -15,6 +15,7 @@
     <xi:include href="xml/ephy-command-manager.xml"/>
     <xi:include href="xml/ephy-embed-single.xml"/>
     <xi:include href="xml/ephy-embed-persist.xml"/>
+    <xi:include href="xml/ephy-embed-factory.xml"/>
   </chapter>
   <chapter>
     <title>Incomplete</title>
@@ -22,6 +23,5 @@
     <xi:include href="xml/ephy-password-manager.xml"/>
     <xi:include href="xml/ephy-session.xml"/>
     <xi:include href="xml/ephy-shell.xml"/>
-    <xi:include href="xml/ephy-embed-factory.xml"/>
   </chapter>
 </book>
diff --git a/doc/reference/epiphany-sections.txt b/doc/reference/epiphany-sections.txt
index 1ecc56bad..390997e5b 100644
--- a/doc/reference/epiphany-sections.txt
+++ b/doc/reference/epiphany-sections.txt
@@ -200,6 +200,12 @@ EPHY_COMMAND_MANAGER_IFACE
 EPHY_IS_COMMAND_MANAGER_IFACE
 </SECTION>
 
+<SECTION>
+<FILE>ephy-embed-factory</FILE>
+<TITLE>EphyEmbedFactory</TITLE>
+ephy_embed_factory_new_object
+</SECTION>
+
 
 
 
@@ -297,11 +303,6 @@ ephy_cookie_get_type
 EPHY_COOKIE_MANAGER_GET_IFACE
 </SECTION>
 
-<SECTION>
-<FILE>ephy-embed-factory</FILE>
-ephy_embed_factory_new_object
-</SECTION>
-
 <SECTION>
 <FILE>EphyContentPolicy</FILE>
 EPHY_CONTENT_POLICY_CONTRACTID
diff --git a/doc/reference/tmpl/ephy-embed-factory.sgml b/doc/reference/tmpl/ephy-embed-factory.sgml
index 4f4f3fa99..f80295416 100644
--- a/doc/reference/tmpl/ephy-embed-factory.sgml
+++ b/doc/reference/tmpl/ephy-embed-factory.sgml
@@ -1,12 +1,18 @@
 <!-- ##### SECTION Title ##### -->
-ephy-embed-factory
+EphyEmbedFactory
 
 <!-- ##### SECTION Short_Description ##### -->
-
+Factory for creating new embed objects
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+#EphyEmbed, #EphyEmbedPersist and #EphyEmbedSingle are all interfaces. In the
+interest of abstraction, the only recommended way to create new instances of
+the objects which implement these interfaces is to use #EphyEmbedFactory.
+</para>
+<para>
+To create a new instance of an #EphyEmbed, #EphyEmbedPersist or
+#EphyEmbedSingle, use ephy_embed_factory_new_object().
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
-- 
cgit v1.2.3