From c835d9f34b984d00708ca7a61bddeb4ce98ca9e7 Mon Sep 17 00:00:00 2001 From: Marco Pesenti Gritti Date: Sat, 22 Nov 2003 14:28:15 +0000 Subject: Add a tip on how to clean docs. 2003-11-22 Marco Pesenti Gritti * 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 --- ChangeLog | 21 +++++ doc/reference-howto.txt | 4 +- doc/reference/Makefile.am | 1 - doc/reference/epiphany-docs.sgml | 5 + doc/reference/epiphany.types | 8 ++ doc/reference/tmpl/ephy-cookie-manager.sgml | 107 +++++++++++++++++++++ doc/reference/tmpl/ephy-embed-factory.sgml | 27 ++++++ doc/reference/tmpl/ephy-embed-single.sgml | 54 +++++++++++ doc/reference/tmpl/ephy-password-manager.sgml | 88 +++++++++++++++++ doc/reference/tmpl/ephy-permission-manager.sgml | 120 ++++++++++++++++++++++++ embed/ephy-embed-factory.c | 14 +++ 11 files changed, 447 insertions(+), 2 deletions(-) create mode 100644 doc/reference/tmpl/ephy-cookie-manager.sgml create mode 100644 doc/reference/tmpl/ephy-embed-factory.sgml create mode 100644 doc/reference/tmpl/ephy-embed-single.sgml create mode 100644 doc/reference/tmpl/ephy-password-manager.sgml create mode 100644 doc/reference/tmpl/ephy-permission-manager.sgml diff --git a/ChangeLog b/ChangeLog index 3769ddc6b..ec201e54e 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,24 @@ +2003-11-22 Marco Pesenti Gritti + + * 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 * src/ephy-location-action.c: (sync_editable), (connect_proxy), 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 @@ [Insert title here] + + + + + 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 #include #include +#include +#include +#include +#include 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 #include 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 @@ + +ephy-cookie-manager + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@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: + + + + + + +@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: + + + + + + +@Returns: + + + + + + + +@cookie: +@Returns: + + + + + + + +@cookie: + + + + + + + +@Returns: + + + + + + + +@manager: +@Returns: + + + + + + + +@manager: +@cookie: + + + + + + + +@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 @@ + +ephy-embed-factory + + + + + + + + + + + + + + + + + + + + + +@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 @@ + +ephy-embed-single + + + + + + + + + + + + + + + + + + + + + +@shell: + + + + + + + +@shell: +@offline: + + + + + + + +@shell: +@url: + + + + + + + +@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 @@ + +ephy-password-manager + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@host: +@username: +@password: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@info: + + + + + + + +@Returns: + + + + + + + +@manager: +@info: + + + + + + + +@manager: +@info: + + + + + + + +@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 @@ + +ephy-permission-manager + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@EPT_COOKIE: +@EPT_IMAGE: +@EPT_PASSWORD: + + + + + + +@host: +@type: +@allowed: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@info: + + + + + + + +@Returns: + + + + + + + +@manager: +@host: +@type: +@allow: + + + + + + + +@manager: +@host: +@type: + + + + + + + +@manager: + + + + + + + +@manager: +@host: +@type: +@Returns: + + + + + + + +@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) { -- cgit v1.2.3