Documented EphyEmbedFactory

5 files changed, 27 insertions, 17 deletions

diff --git a/ChangeLog b/ChangeLog
index 27a84c362..8b01ef7a8 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2004-03-30  Adam Hooper  <adamh@cvs.gnome.org>
+
+	* doc/reference/epiphany-docs.sgml:
+	* doc/reference/epiphany-sections.txt:
+	* doc/reference/tmpl/ephy-embed-factory.sgml:
+	* embed/ephy-embed-factory.c:
+
+	Documented EphyEmbedFactory. My, that was challenging. Not.
+
 2004-03-29  Christian Persch  <chpe@cvs.gnome.org>
 
 	* embed/mozilla/GtkNSSClientAuthDialogs.cpp:
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>
+
 
 
 
@@ -298,11 +304,6 @@ 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
 EPHY_CONTENT_POLICY_CLASSNAME
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 ##### -->
diff --git a/embed/ephy-embed-factory.c b/embed/ephy-embed-factory.c
index e753f4827..5a81004f0 100644
--- a/embed/ephy-embed-factory.c
+++ b/embed/ephy-embed-factory.c
@@ -65,14 +65,8 @@ type_from_id (const char *object_id)
  * ephy_embed_factory_new_object:
  * @object_id: identifier of the object to create
  * 
- * Create an instance of the object identified by
- * object_id string. Valid ids are EphyEmbed, EphyEmbedPersist,
- * EphyEmbedSingle.
- * We use a factory instead of creating instances directly
- * to keep the embed implementation abstract. All the embed
- * objects should be based on an interface and created by
- * this factory.
- * 
+ * Create an instance of the object identified by @object_id.
+ *
  * Return value: the object instance
  **/
 GObject	*