aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAdam Hooper <adamh@src.gnome.org>2004-03-30 20:52:33 +0800
committerAdam Hooper <adamh@src.gnome.org>2004-03-30 20:52:33 +0800
commitb1a82315dfe5b3c1d8cfb5b33df0d013fc83a87f (patch)
treebdee3876d1b3213bb2db0cb9e4824115787924f3 /doc
parent606e1b5132db448875d659e8817c3bbe942d1647 (diff)
downloadgsoc2013-epiphany-b1a82315dfe5b3c1d8cfb5b33df0d013fc83a87f.tar.gz
gsoc2013-epiphany-b1a82315dfe5b3c1d8cfb5b33df0d013fc83a87f.tar.zst
gsoc2013-epiphany-b1a82315dfe5b3c1d8cfb5b33df0d013fc83a87f.zip
Documented EphyEmbedFactory
Diffstat (limited to 'doc')
-rw-r--r--doc/reference/epiphany-docs.sgml2
-rw-r--r--doc/reference/epiphany-sections.txt11
-rw-r--r--doc/reference/tmpl/ephy-embed-factory.sgml12
3 files changed, 16 insertions, 9 deletions
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 ##### -->