diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/reference-howto.txt | 4 | ||||
| -rw-r--r-- | doc/reference/Makefile.am | 1 | ||||
| -rw-r--r-- | doc/reference/epiphany-docs.sgml | 5 | ||||
| -rw-r--r-- | doc/reference/epiphany.types | 8 | ||||
| -rw-r--r-- | doc/reference/tmpl/ephy-cookie-manager.sgml | 107 | ||||
| -rw-r--r-- | doc/reference/tmpl/ephy-embed-factory.sgml | 27 | ||||
| -rw-r--r-- | doc/reference/tmpl/ephy-embed-single.sgml | 54 | ||||
| -rw-r--r-- | doc/reference/tmpl/ephy-password-manager.sgml | 88 | ||||
| -rw-r--r-- | doc/reference/tmpl/ephy-permission-manager.sgml | 120 |
9 files changed, 412 insertions, 2 deletions
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: + + |