aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAdam Hooper <adamh@src.gnome.org>2004-03-27 06:10:03 +0800
committerAdam Hooper <adamh@src.gnome.org>2004-03-27 06:10:03 +0800
commitea323c1d7f28e2a03b7b1752de25a975218a488d (patch)
tree7f8f06dd5555efc1ccffe475541aaece3a0864c2
parent392862972143af3915942456b6a6665d95a79fcb (diff)
downloadgsoc2013-epiphany-ea323c1d7f28e2a03b7b1752de25a975218a488d.tar
gsoc2013-epiphany-ea323c1d7f28e2a03b7b1752de25a975218a488d.tar.gz
gsoc2013-epiphany-ea323c1d7f28e2a03b7b1752de25a975218a488d.tar.bz2
gsoc2013-epiphany-ea323c1d7f28e2a03b7b1752de25a975218a488d.tar.lz
gsoc2013-epiphany-ea323c1d7f28e2a03b7b1752de25a975218a488d.tar.xz
gsoc2013-epiphany-ea323c1d7f28e2a03b7b1752de25a975218a488d.tar.zst
gsoc2013-epiphany-ea323c1d7f28e2a03b7b1752de25a975218a488d.zip
Documented EphyEmbedSingle
-rw-r--r--ChangeLog22
-rw-r--r--doc/reference/epiphany-docs.sgml2
-rw-r--r--doc/reference/epiphany-sections.txt35
-rw-r--r--doc/reference/tmpl/ephy-embed-single.sgml52
-rw-r--r--doc/reference/tmpl/ephy-tab.sgml50
-rw-r--r--doc/reference/tmpl/epiphany-unused.sgml14
-rw-r--r--embed/ephy-embed-single.c59
-rw-r--r--embed/ephy-embed-single.h18
-rw-r--r--embed/ephy-embed.c4
9 files changed, 186 insertions, 70 deletions
diff --git a/ChangeLog b/ChangeLog
index 92401b863..f23b6b07a 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,25 @@
+2004-03-26 Adam Hooper <adamh@cvs.gnome.org>
+
+ * doc/reference/epiphany-docs.sgml:
+ * doc/reference/epiphany-sections.txt:
+ * doc/reference/tmpl/ephy-embed-single.sgml:
+ * doc/reference/tmpl/epiphany-unused.sgml:
+ * embed/ephy-embed-single.c: (ephy_embed_single_iface_init),
+ (ephy_embed_single_load_proxy_autoconf),
+ (ephy_embed_single_get_font_list):
+ * embed/ephy-embed-single.h:
+
+ Documented EphyEmbedSingle. Made argument names consistent across the
+ c and header files.
+
+ * embed/ephy-embed.c:
+
+ Fix gtk-doc warnings
+
+ * doc/reference/tmpl/ephy-tab.sgml:
+
+ All the properties showed up when chpe fixed gtk-doc-ness.
+
2004-03-26 Piers Cornwell <piers@gnome.org>
* src/ephy-window.c: (confirm_close_with_modified_forms):
diff --git a/doc/reference/epiphany-docs.sgml b/doc/reference/epiphany-docs.sgml
index 92185ba87..aa8abfa73 100644
--- a/doc/reference/epiphany-docs.sgml
+++ b/doc/reference/epiphany-docs.sgml
@@ -12,10 +12,10 @@
<xi:include href="xml/ephy-window.xml"/>
<xi:include href="xml/ephy-tab.xml"/>
<xi:include href="xml/ephy-embed.xml"/>
+ <xi:include href="xml/ephy-embed-single.xml"/>
</chapter>
<chapter>
<title>Incomplete</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-session.xml"/>
diff --git a/doc/reference/epiphany-sections.txt b/doc/reference/epiphany-sections.txt
index 5d6d8bda3..3cb40f04e 100644
--- a/doc/reference/epiphany-sections.txt
+++ b/doc/reference/epiphany-sections.txt
@@ -132,6 +132,24 @@ EPHY_IS_EMBED_IFACE
EPHY_TYPE_EMBED_CHROME_MASK
</SECTION>
+<SECTION>
+<FILE>ephy-embed-single</FILE>
+<TITLE>EphyEmbedSingle</TITLE>
+ephy_embed_single_clear_cache
+ephy_embed_single_clear_auth_cache
+ephy_embed_single_set_offline_mode
+ephy_embed_single_load_proxy_autoconf
+ephy_embed_single_get_font_list
+<SUBSECTION Standard>
+EPHY_EMBED_SINGLE
+EPHY_IS_EMBED_SINGLE
+EPHY_TYPE_EMBED_SINGLE
+ephy_embed_single_get_type
+EPHY_EMBED_SINGLE_GET_IFACE
+EPHY_EMBED_SINGLE_IFACE
+EPHY_IS_EMBED_SINGLE_IFACE
+</SECTION>
+
@@ -231,23 +249,6 @@ EPHY_COOKIE_MANAGER_GET_IFACE
</SECTION>
<SECTION>
-<FILE>ephy-embed-single</FILE>
-EPHY_EMBED_SINGLE_IFACE
-EPHY_IS_EMBED_SINGLE_IFACE
-ephy_embed_single_clear_cache
-ephy_embed_single_clear_auth_cache
-ephy_embed_single_set_offline_mode
-ephy_embed_single_load_proxy_autoconf
-ephy_embed_single_get_font_list
-<SUBSECTION Standard>
-EPHY_EMBED_SINGLE
-EPHY_IS_EMBED_SINGLE
-EPHY_TYPE_EMBED_SINGLE
-ephy_embed_single_get_type
-EPHY_EMBED_SINGLE_GET_IFACE
-</SECTION>
-
-<SECTION>
<FILE>ephy-embed-factory</FILE>
ephy_embed_factory_new_object
</SECTION>
diff --git a/doc/reference/tmpl/ephy-embed-single.sgml b/doc/reference/tmpl/ephy-embed-single.sgml
index 29899db97..3368ee788 100644
--- a/doc/reference/tmpl/ephy-embed-single.sgml
+++ b/doc/reference/tmpl/ephy-embed-single.sgml
@@ -1,40 +1,47 @@
<!-- ##### SECTION Title ##### -->
-ephy-embed-single
+EphyEmbedSingle
<!-- ##### SECTION Short_Description ##### -->
-
+An interface to the global embedded browser
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+While Epiphany is running, its global embed_shell variable (an #EphyEmbedShell)
+holds a reference to an #EphyEmbedSingle. The only class which implements
+#EphyEmbedSingle is #MozillaEmbedSingle, so the two types are interchangeable
+via casting.
</para>
-
-<!-- ##### SECTION See_Also ##### -->
<para>
+<example>
+<title>Acquiring an <structname>EphyEmbedSingle</structname></title>
+<programlisting>#<![CDATA[include <ephy-embed-shell.h>]]>
+#<![CDATA[include <ephy-embed-single.h>
-</para>
+EphyEmbedSingle *ephy_single;
-<!-- ##### MACRO EPHY_EMBED_SINGLE_IFACE ##### -->
+/* embed_shell is a global variable, initialized as Epiphany starts */
+ephy_single = ephy_embed_shell_get_embed_single (embed_shell);
+]]></programlisting>
+</example>
+</para>
<para>
-
+Since there is only one #EphyEmbedShell, there is only one #EphyEmbedSingle. It
+is used to perform browser-related actions which do not refer to an individual
+#EphyEmbed.
</para>
-@k:
-
-
-<!-- ##### MACRO EPHY_IS_EMBED_SINGLE_IFACE ##### -->
+<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-@k:
-
-
<!-- ##### FUNCTION ephy_embed_single_clear_cache ##### -->
<para>
</para>
+@single:
+<!-- # Unused Parameters # -->
@shell:
@@ -43,6 +50,8 @@ ephy-embed-single
</para>
+@single:
+<!-- # Unused Parameters # -->
@shell:
@@ -51,8 +60,10 @@ ephy-embed-single
</para>
-@shell:
+@single:
@offline:
+<!-- # Unused Parameters # -->
+@shell:
<!-- ##### FUNCTION ephy_embed_single_load_proxy_autoconf ##### -->
@@ -60,8 +71,10 @@ ephy-embed-single
</para>
-@shell:
+@single:
@url:
+<!-- # Unused Parameters # -->
+@shell:
<!-- ##### FUNCTION ephy_embed_single_get_font_list ##### -->
@@ -69,8 +82,11 @@ ephy-embed-single
</para>
+@single:
+@lang_group:
+@Returns:
+<!-- # Unused Parameters # -->
@shell:
@langGroup:
-@Returns:
diff --git a/doc/reference/tmpl/ephy-tab.sgml b/doc/reference/tmpl/ephy-tab.sgml
index 94d71bb1f..ae5eba7b0 100644
--- a/doc/reference/tmpl/ephy-tab.sgml
+++ b/doc/reference/tmpl/ephy-tab.sgml
@@ -128,3 +128,53 @@ An #EphyTab is basically a container for an #EphyEmbed.
@Returns:
+<!-- ##### ARG EphyTab:address ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EphyTab:icon ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EphyTab:load-progress ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EphyTab:load-status ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EphyTab:message ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EphyTab:navigation ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EphyTab:security-level ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EphyTab:title ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EphyTab:visible ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG EphyTab:zoom ##### -->
+<para>
+
+</para>
+
diff --git a/doc/reference/tmpl/epiphany-unused.sgml b/doc/reference/tmpl/epiphany-unused.sgml
index 5fcda58b0..2932d9274 100644
--- a/doc/reference/tmpl/epiphany-unused.sgml
+++ b/doc/reference/tmpl/epiphany-unused.sgml
@@ -18,6 +18,20 @@
mozilla-embed-event
+<!-- ##### MACRO EPHY_EMBED_SINGLE_IFACE ##### -->
+<para>
+
+</para>
+
+@k:
+
+<!-- ##### MACRO EPHY_IS_EMBED_SINGLE_IFACE ##### -->
+<para>
+
+</para>
+
+@k:
+
<!-- ##### MACRO EPHY_SHELL_TYPE_DEF ##### -->
<para>
diff --git a/embed/ephy-embed-single.c b/embed/ephy-embed-single.c
index c0303af7c..72891edf8 100644
--- a/embed/ephy-embed-single.c
+++ b/embed/ephy-embed-single.c
@@ -57,17 +57,19 @@ ephy_embed_single_iface_init (gpointer g_class)
if (initialised == FALSE)
{
- /**
- * EphyEmbedSingle::handle_content
- * @single: the #EphyEmbedSingle
- * @mime_type: the mime type of the content
- * @address: the address of the content
- *
- * The handle_content signal is emitted when encountering content
- * of a mime type Epiphany is unable to handle itself.
- *
- * Returning TRUE will stop the signal emission.
- **/
+/**
+ * EphyEmbedSingle::handle_content:
+ * @single:
+ * @mime_type: the MIME type of the content
+ * @address: the URL to the content
+ *
+ * The ::handle_content signal is emitted when encountering content of a mime
+ * type Epiphany is unable to handle itself.
+ *
+ * If a connected callback returns %TRUE, the signal will stop propagating. For
+ * example, this could be used by a download manager to prevent other
+ * ::handle_content listeners from being called.
+ **/
g_signal_new ("handle_content",
EPHY_TYPE_EMBED_SINGLE,
G_SIGNAL_RUN_LAST,
@@ -87,7 +89,7 @@ ephy_embed_single_iface_init (gpointer g_class)
* ephy_embed_single_clear_cache:
* @single: the #EphyEmbedSingle
*
- * Clears the mozilla cache.
+ * Clears the Mozilla cache (temporarily saved web pages).
**/
void
ephy_embed_single_clear_cache (EphyEmbedSingle *single)
@@ -100,7 +102,15 @@ ephy_embed_single_clear_cache (EphyEmbedSingle *single)
* ephy_embed_single_clear_auth_cache:
* @single: the #EphyEmbedSingle
*
- * Clears the mozilla http authentication cache.
+ * Clears the Mozilla HTTP authentication cache.
+ *
+ * This does not clear regular website passwords; it only clears the HTTP
+ * authentication cache. Websites which use HTTP authentication require the
+ * browser to send a password along with every HTTP request; the browser will
+ * ask the user for the password once and then cache the password for subsequent
+ * HTTP requests. This function will clear the HTTP authentication cache,
+ * meaning the user will have to re-enter a username and password the next time
+ * Epiphany requests a web page secured with HTTP authentication.
**/
void
ephy_embed_single_clear_auth_cache (EphyEmbedSingle *single)
@@ -112,9 +122,9 @@ ephy_embed_single_clear_auth_cache (EphyEmbedSingle *single)
/**
* ephy_embed_single_set_offline_mode:
* @single: the #EphyEmbedSingle
- * @offline: whether being off-line
+ * @offline: %TRUE to disable networking
*
- * Sets the state of the net connection.
+ * Sets the state of the network connection.
**/
void
ephy_embed_single_set_offline_mode (EphyEmbedSingle *single,
@@ -127,32 +137,35 @@ ephy_embed_single_set_offline_mode (EphyEmbedSingle *single,
/**
* ephy_embed_single_load_proxy_autoconf:
* @single: the #EphyEmbedSingle
- * @address: the address of the PAC file
+ * @url: a URL to a PAC file
*
* Sets the address of the PAC file, and loads the proxy configuration from it.
**/
void
ephy_embed_single_load_proxy_autoconf (EphyEmbedSingle *single,
- const char* address)
+ const char* url)
{
EphyEmbedSingleIface *iface = EPHY_EMBED_SINGLE_GET_IFACE (single);
- iface->load_proxy_autoconf (single, address);
+ iface->load_proxy_autoconf (single, url);
}
/**
* ephy_embed_single_get_font_list:
* @single: the #EphyEmbedSingle
- * @langGroup: a mozilla font language group name, or NULL
+ * @lang_group: a mozilla font language group name, or %NULL
*
- * Returns the list of fonts matching @langGroup, or all fonts if @langGroup is
- * NULL.
+ * Returns the list of fonts matching @lang_group, or all fonts if @lang_group
+ * is %NULL.
+ *
+ * The available @lang_group arguments are listed in Epiphany's Fonts and Colors
+ * preferences.
*
* Return value: a list of font names
**/
GList *
ephy_embed_single_get_font_list (EphyEmbedSingle *single,
- const char *langGroup)
+ const char *lang_group)
{
EphyEmbedSingleIface *iface = EPHY_EMBED_SINGLE_GET_IFACE (single);
- return iface->get_font_list (single, langGroup);
+ return iface->get_font_list (single, lang_group);
}
diff --git a/embed/ephy-embed-single.h b/embed/ephy-embed-single.h
index f9db7cfb9..f78910e90 100644
--- a/embed/ephy-embed-single.h
+++ b/embed/ephy-embed-single.h
@@ -33,10 +33,10 @@ G_BEGIN_DECLS
#define EPHY_IS_EMBED_SINGLE_IFACE(k) (G_TYPE_CHECK_CLASS_TYPE ((k), EPHY_TYPE_EMBED_SINGLE))
#define EPHY_EMBED_SINGLE_GET_IFACE(i) (G_TYPE_INSTANCE_GET_INTERFACE ((i), EPHY_TYPE_EMBED_SINGLE, EphyEmbedSingleIface))
-typedef struct EphyEmbedSingle EphyEmbedSingle;
-typedef struct EphyEmbedSingleIface EphyEmbedSingleIface;
+typedef struct _EphyEmbedSingle EphyEmbedSingle;
+typedef struct _EphyEmbedSingleIface EphyEmbedSingleIface;
-struct EphyEmbedSingleIface
+struct _EphyEmbedSingleIface
{
GTypeInterface base_iface;
@@ -60,18 +60,18 @@ struct EphyEmbedSingleIface
GType ephy_embed_single_get_type (void);
-void ephy_embed_single_clear_cache (EphyEmbedSingle *shell);
+void ephy_embed_single_clear_cache (EphyEmbedSingle *single);
-void ephy_embed_single_clear_auth_cache (EphyEmbedSingle *shell);
+void ephy_embed_single_clear_auth_cache (EphyEmbedSingle *single);
-void ephy_embed_single_set_offline_mode (EphyEmbedSingle *shell,
+void ephy_embed_single_set_offline_mode (EphyEmbedSingle *single,
gboolean offline);
-void ephy_embed_single_load_proxy_autoconf (EphyEmbedSingle *shell,
+void ephy_embed_single_load_proxy_autoconf (EphyEmbedSingle *single,
const char* url);
-GList *ephy_embed_single_get_font_list (EphyEmbedSingle *shell,
- const char *langGroup);
+GList *ephy_embed_single_get_font_list (EphyEmbedSingle *single,
+ const char *lang_group);
G_END_DECLS
diff --git a/embed/ephy-embed.c b/embed/ephy-embed.c
index 6156051f4..00f8b25d8 100644
--- a/embed/ephy-embed.c
+++ b/embed/ephy-embed.c
@@ -536,7 +536,7 @@ ephy_embed_shistory_n_items (EphyEmbed *embed)
* @url: returned value of the history entry's URL
* @title: returned value of the history entry's title
*
- * Returns the @url and @title of the @nth item in @embed's session history.
+ * Fetches the @url and @title of the @nth item in @embed's session history.
* If @is_relative is %TRUE, @nth is an offset from the browser's current
* history position. For example, calling this function with @is_relative %TRUE
* and @nth %0 will return the URL and title of the current page.
@@ -590,7 +590,7 @@ ephy_embed_shistory_go_nth (EphyEmbed *embed,
* @level: return value of security level
* @description: return value of the description of the security level
*
- * Returns the an #EmbedSecurityLevel and a newly-allocated string description
+ * Fetches the #EmbedSecurityLevel and a newly-allocated string description
* of the security state of @embed.
**/
void