aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarco Pesenti Gritti <marco@gnome.org>2003-11-22 22:28:15 +0800
committerMarco Pesenti Gritti <marco@src.gnome.org>2003-11-22 22:28:15 +0800
commitc835d9f34b984d00708ca7a61bddeb4ce98ca9e7 (patch)
tree843a74f8eed67131039b5143ffd839db9cf156f5
parentdaa7ef352dea475a96aa1c7534b8a874521312fd (diff)
downloadgsoc2013-epiphany-c835d9f34b984d00708ca7a61bddeb4ce98ca9e7.tar
gsoc2013-epiphany-c835d9f34b984d00708ca7a61bddeb4ce98ca9e7.tar.gz
gsoc2013-epiphany-c835d9f34b984d00708ca7a61bddeb4ce98ca9e7.tar.bz2
gsoc2013-epiphany-c835d9f34b984d00708ca7a61bddeb4ce98ca9e7.tar.lz
gsoc2013-epiphany-c835d9f34b984d00708ca7a61bddeb4ce98ca9e7.tar.xz
gsoc2013-epiphany-c835d9f34b984d00708ca7a61bddeb4ce98ca9e7.tar.zst
gsoc2013-epiphany-c835d9f34b984d00708ca7a61bddeb4ce98ca9e7.zip
Add a tip on how to clean docs.
2003-11-22 Marco Pesenti Gritti <marco@gnome.org> * doc/reference-howto.txt: Add a tip on how to clean docs. * doc/reference/Makefile.am: * doc/reference/epiphany-docs.sgml: * doc/reference/epiphany.types: * doc/reference/tmpl/ephy-cookie-manager.sgml: * doc/reference/tmpl/ephy-embed-factory.sgml: * doc/reference/tmpl/ephy-embed-single.sgml: * doc/reference/tmpl/ephy-password-manager.sgml: * doc/reference/tmpl/ephy-permission-manager.sgml: Add some files chpe documented to the build. * embed/ephy-embed-factory.c: Document
-rw-r--r--ChangeLog21
-rw-r--r--doc/reference-howto.txt4
-rw-r--r--doc/reference/Makefile.am1
-rw-r--r--doc/reference/epiphany-docs.sgml5
-rw-r--r--doc/reference/epiphany.types8
-rw-r--r--doc/reference/tmpl/ephy-cookie-manager.sgml107
-rw-r--r--doc/reference/tmpl/ephy-embed-factory.sgml27
-rw-r--r--doc/reference/tmpl/ephy-embed-single.sgml54
-rw-r--r--doc/reference/tmpl/ephy-password-manager.sgml88
-rw-r--r--doc/reference/tmpl/ephy-permission-manager.sgml120
-rw-r--r--embed/ephy-embed-factory.c14
11 files changed, 447 insertions, 2 deletions
diff --git a/ChangeLog b/ChangeLog
index 3769ddc6b..ec201e54e 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,26 @@
2003-11-22 Marco Pesenti Gritti <marco@gnome.org>
+ * doc/reference-howto.txt:
+
+ Add a tip on how to clean docs.
+
+ * doc/reference/Makefile.am:
+ * doc/reference/epiphany-docs.sgml:
+ * doc/reference/epiphany.types:
+ * doc/reference/tmpl/ephy-cookie-manager.sgml:
+ * doc/reference/tmpl/ephy-embed-factory.sgml:
+ * doc/reference/tmpl/ephy-embed-single.sgml:
+ * doc/reference/tmpl/ephy-password-manager.sgml:
+ * doc/reference/tmpl/ephy-permission-manager.sgml:
+
+ Add some files chpe documented to the build.
+
+ * embed/ephy-embed-factory.c:
+
+ Document
+
+2003-11-22 Marco Pesenti Gritti <marco@gnome.org>
+
* src/ephy-location-action.c: (sync_editable), (connect_proxy),
(ephy_location_action_set_property),
(ephy_location_action_get_property),
diff --git a/doc/reference-howto.txt b/doc/reference-howto.txt
index 314eac714..743b636aa 100644
--- a/doc/reference-howto.txt
+++ b/doc/reference-howto.txt
@@ -25,5 +25,7 @@ the .h in doc/reference/epiphany.types.
- Remove the .h from the IGNORE_HFILES section of
doc/reference/Makefile.am
+- Clean current docs build using "make maintainer-clean-local"
+
- Build and commit both the modified .c and the sgml generated
-in doc/reference/tmpl
+in doc/reference/tmpl.
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index 9c531717d..11c9bce0c 100644
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -71,7 +71,6 @@ IGNORE_HFILES = \
ephy-embed-popup-control.h \
ephy-embed-prefs.h \
ephy-embed-shell.h \
- ephy-embed-single.h \
ephy-encodings.h \
ephy-favicon-cache.h \
ephy-history.h \
diff --git a/doc/reference/epiphany-docs.sgml b/doc/reference/epiphany-docs.sgml
index a059e283a..84e8664e8 100644
--- a/doc/reference/epiphany-docs.sgml
+++ b/doc/reference/epiphany-docs.sgml
@@ -8,7 +8,12 @@
<chapter>
<title>[Insert title here]</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-permission-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.types b/doc/reference/epiphany.types
index 5b19d2a3a..69a003fff 100644
--- a/doc/reference/epiphany.types
+++ b/doc/reference/epiphany.types
@@ -25,6 +25,10 @@ ephy_cell_renderer_progress_get_type
#include <ephy-embed-dialog.h>
#include <ephy-embed-event.h>
#include <ephy-embed-persist.h>
+#include <ephy-embed-single.h>
+#include <ephy-cookie-manager.h>
+#include <ephy-password-manager.h>
+#include <ephy-permission-manager.h>
ephy_embed_get_type
downloader_view_get_type
@@ -33,6 +37,10 @@ ephy_download_get_type
ephy_embed_dialog_get_type
ephy_embed_event_get_type
ephy_embed_persist_get_type
+ephy_embed_single_get_type
+ephy_cookie_manager_get_type
+ephy_permission_manager_get_type
+ephy_password_manager_get_type
#include <ephy-window.h>
#include <ephy-shell.h>
diff --git a/doc/reference/tmpl/ephy-cookie-manager.sgml b/doc/reference/tmpl/ephy-cookie-manager.sgml
new file mode 100644
index 000000000..80affb1dd
--- /dev/null
+++ b/doc/reference/tmpl/ephy-cookie-manager.sgml
@@ -0,0 +1,107 @@
+<!-- ##### SECTION Title ##### -->
+ephy-cookie-manager
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### MACRO EPHY_TYPE_COOKIE ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### ENUM EphyCookieP3PState ##### -->
+<para>
+
+</para>
+
+@EPHY_COOKIE_P3P_STATE_UNKNOWN:
+@EPHY_COOKIE_P3P_STATE_ACCEPTED:
+@EPHY_COOKIE_P3P_STATE_DOWNGRADED:
+@EPHY_COOKIE_P3P_STATE_FLAGGED:
+@EPHY_COOKIE_P3P_STATE_REJECTED:
+
+<!-- ##### ENUM EphyCookieP3PPolicy ##### -->
+<para>
+
+</para>
+
+@EPHY_COOKIE_P3P_POLICY_UNKNOWN:
+@EPHY_COOKIE_P3P_POLICY_NONE:
+@EPHY_COOKIE_P3P_POLICY_NO_CONSENT:
+@EPHY_COOKIE_P3P_POLICY_IMPLICIT_CONSENT:
+@EPHY_COOKIE_P3P_POLICY_EXPLICIT_CONSENT:
+@EPHY_COOKIE_P3P_POLICY_NO_II:
+
+<!-- ##### FUNCTION ephy_cookie_new ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_cookie_copy ##### -->
+<para>
+
+</para>
+
+@cookie:
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_cookie_free ##### -->
+<para>
+
+</para>
+
+@cookie:
+
+
+<!-- ##### FUNCTION ephy_cookie_manager_get_type ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_cookie_manager_list_cookies ##### -->
+<para>
+
+</para>
+
+@manager:
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_cookie_manager_remove_cookie ##### -->
+<para>
+
+</para>
+
+@manager:
+@cookie:
+
+
+<!-- ##### FUNCTION ephy_cookie_manager_clear ##### -->
+<para>
+
+</para>
+
+@manager:
+
+
diff --git a/doc/reference/tmpl/ephy-embed-factory.sgml b/doc/reference/tmpl/ephy-embed-factory.sgml
new file mode 100644
index 000000000..c08fd6790
--- /dev/null
+++ b/doc/reference/tmpl/ephy-embed-factory.sgml
@@ -0,0 +1,27 @@
+<!-- ##### SECTION Title ##### -->
+ephy-embed-factory
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION ephy_embed_factory_new_object ##### -->
+<para>
+
+</para>
+
+@object_id:
+@Returns:
+
+
diff --git a/doc/reference/tmpl/ephy-embed-single.sgml b/doc/reference/tmpl/ephy-embed-single.sgml
new file mode 100644
index 000000000..7963ed4aa
--- /dev/null
+++ b/doc/reference/tmpl/ephy-embed-single.sgml
@@ -0,0 +1,54 @@
+<!-- ##### SECTION Title ##### -->
+ephy-embed-single
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION ephy_embed_single_clear_cache ##### -->
+<para>
+
+</para>
+
+@shell:
+
+
+<!-- ##### FUNCTION ephy_embed_single_set_offline_mode ##### -->
+<para>
+
+</para>
+
+@shell:
+@offline:
+
+
+<!-- ##### FUNCTION ephy_embed_single_load_proxy_autoconf ##### -->
+<para>
+
+</para>
+
+@shell:
+@url:
+
+
+<!-- ##### FUNCTION ephy_embed_single_get_font_list ##### -->
+<para>
+
+</para>
+
+@shell:
+@langGroup:
+@Returns:
+
+
diff --git a/doc/reference/tmpl/ephy-password-manager.sgml b/doc/reference/tmpl/ephy-password-manager.sgml
new file mode 100644
index 000000000..edd59d1ad
--- /dev/null
+++ b/doc/reference/tmpl/ephy-password-manager.sgml
@@ -0,0 +1,88 @@
+<!-- ##### SECTION Title ##### -->
+ephy-password-manager
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### MACRO EPHY_TYPE_PASSWORD_INFO ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION ephy_password_info_new ##### -->
+<para>
+
+</para>
+
+@host:
+@username:
+@password:
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_password_info_copy ##### -->
+<para>
+
+</para>
+
+@info:
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_password_info_free ##### -->
+<para>
+
+</para>
+
+@info:
+
+
+<!-- ##### FUNCTION ephy_password_manager_get_type ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_password_manager_add ##### -->
+<para>
+
+</para>
+
+@manager:
+@info:
+
+
+<!-- ##### FUNCTION ephy_password_manager_remove ##### -->
+<para>
+
+</para>
+
+@manager:
+@info:
+
+
+<!-- ##### FUNCTION ephy_password_manager_list ##### -->
+<para>
+
+</para>
+
+@manager:
+@Returns:
+
+
diff --git a/doc/reference/tmpl/ephy-permission-manager.sgml b/doc/reference/tmpl/ephy-permission-manager.sgml
new file mode 100644
index 000000000..caeb71c97
--- /dev/null
+++ b/doc/reference/tmpl/ephy-permission-manager.sgml
@@ -0,0 +1,120 @@
+<!-- ##### SECTION Title ##### -->
+ephy-permission-manager
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### MACRO EPHY_TYPE_PERMISSION_INFO ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### ENUM EphyPermissionType ##### -->
+<para>
+
+</para>
+
+@EPT_COOKIE:
+@EPT_IMAGE:
+@EPT_PASSWORD:
+
+<!-- ##### FUNCTION ephy_permission_info_new ##### -->
+<para>
+
+</para>
+
+@host:
+@type:
+@allowed:
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_permission_info_copy ##### -->
+<para>
+
+</para>
+
+@info:
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_permission_info_free ##### -->
+<para>
+
+</para>
+
+@info:
+
+
+<!-- ##### FUNCTION ephy_permission_manager_get_type ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_permission_manager_add ##### -->
+<para>
+
+</para>
+
+@manager:
+@host:
+@type:
+@allow:
+
+
+<!-- ##### FUNCTION ephy_permission_manager_remove ##### -->
+<para>
+
+</para>
+
+@manager:
+@host:
+@type:
+
+
+<!-- ##### FUNCTION ephy_permission_manager_clear ##### -->
+<para>
+
+</para>
+
+@manager:
+
+
+<!-- ##### FUNCTION ephy_permission_manager_test ##### -->
+<para>
+
+</para>
+
+@manager:
+@host:
+@type:
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_permission_manager_list ##### -->
+<para>
+
+</para>
+
+@manager:
+@type:
+@Returns:
+
+
diff --git a/embed/ephy-embed-factory.c b/embed/ephy-embed-factory.c
index 74dfd4853..4c527234f 100644
--- a/embed/ephy-embed-factory.c
+++ b/embed/ephy-embed-factory.c
@@ -56,6 +56,20 @@ type_from_id (const char *object_id)
return result;
}
+/**
+ * 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.
+ *
+ * Return value: the object instance
+ **/
GObject *
ephy_embed_factory_new_object (const char *object_id)
{