summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDan Winship <danw@gnome.org>2012-12-27 21:13:34 -0500
committerDan Winship <danw@gnome.org>2012-12-27 21:13:34 -0500
commit0aeb67d4934d2748002349669caeffe481dd5a11 (patch)
tree39139bea35c1267d02e85006395892464105e45b /docs
parentfb30256920503cc5e4dc33210921a2ee2a9ff7c8 (diff)
downloadlibsoup-0aeb67d4934d2748002349669caeffe481dd5a11.tar.gz
libsoup-0aeb67d4934d2748002349669caeffe481dd5a11.tar.bz2
libsoup-0aeb67d4934d2748002349669caeffe481dd5a11.zip
docs: Lots of minor fixes and additions
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/Makefile.am6
-rw-r--r--docs/reference/client-howto.xml15
-rw-r--r--docs/reference/libsoup-2.4-sections.txt54
3 files changed, 52 insertions, 23 deletions
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 2e2a8af6..9dbadb30 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -13,7 +13,7 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
DOC_SOURCE_DIR=../../libsoup
# Extra options to supply to gtkdoc-scan.
-SCAN_OPTIONS=--deprecated-guards=LIBSOUP_DISABLE_DEPRECATED --rebuild-types
+SCAN_OPTIONS=--rebuild-types
# Extra options to supply to gtkdoc-scangobj.
SCANGOBJ_OPTIONS=
@@ -41,7 +41,9 @@ IGNORE_HFILES= soup.h soup-marshal.h soup-enum-types.h \
soup-body-input-stream.h soup-body-output-stream.h \
soup-client-input-stream.h soup-content-processor.h \
soup-content-sniffer-stream.h soup-io-stream.h \
- soup-filter-input-stream.h
+ soup-cache-input-stream.h soup-filter-input-stream.h \
+ soup-cookie-jar-sqlite.h soup-requester.h soup-tld-private.h \
+ soup-misc-private.h
# Images to copy into HTML directory.
HTML_IMAGES =
diff --git a/docs/reference/client-howto.xml b/docs/reference/client-howto.xml
index a53f2ac3..3cf5a4e1 100644
--- a/docs/reference/client-howto.xml
+++ b/docs/reference/client-howto.xml
@@ -164,22 +164,15 @@ functions. Some of the features available in
track of cookies between sessions.
</para></listitem>
</varlistentry>
-</variablelist>
-
-<para>
-And in <application>libsoup-gnome</application>:
-</para>
-
-<variablelist>
<varlistentry>
- <term><link linkend="SOUP-TYPE-PROXY-RESOLVER-GNOME:CAPS"><type>SoupProxyResolverGNOME</type></link></term>
+ <term><link linkend="SoupProxyResolverDefault"><type>SoupProxyResolverDefault</type></link></term>
<listitem><para>
A feature that automatically determines the correct HTTP
proxy to use for requests.
</para></listitem>
</varlistentry>
<varlistentry>
- <term><link linkend="SoupCookieJarSqlite"><type>SoupCookieJarSqlite</type></link></term>
+ <term><link linkend="SoupCookieJarDB"><type>SoupCookieJarDB</type></link></term>
<listitem><para>
Support for HTTP cookies stored in an
<application>SQLite</application> database.
@@ -190,7 +183,7 @@ And in <application>libsoup-gnome</application>:
<para>
Use the "add_feature_by_type" property/function to add features that
don't require any configuration (such as <link
-linkend="SOUP-TYPE-PROXY-RESOLVER-GNOME:CAPS"><type>SoupProxyResolverGNOME</type></link>),
+linkend="SoupProxyResolverDefault"><type>SoupProxyResolverDefault</type></link>),
and the "add_feature" property/function to add features that must be
constructed first (such as <link
linkend="SoupLogger"><type>SoupLogger</type></link>). For example, an
@@ -200,7 +193,7 @@ application might do something like the following:
<informalexample><programlisting>
session = soup_session_async_new_with_options (
#ifdef HAVE_LIBSOUP_GNOME
- SOUP_SESSION_ADD_FEATURE_BY_TYPE, SOUP_TYPE_PROXY_RESOLVER_GNOME,
+ SOUP_SESSION_ADD_FEATURE_BY_TYPE, SOUP_TYPE_PROXY_RESOLVER_DEFAULT,
#endif
NULL);
if (debug_level) {
diff --git a/docs/reference/libsoup-2.4-sections.txt b/docs/reference/libsoup-2.4-sections.txt
index b2952fd0..23f55c0f 100644
--- a/docs/reference/libsoup-2.4-sections.txt
+++ b/docs/reference/libsoup-2.4-sections.txt
@@ -371,6 +371,7 @@ SOUP_ADDRESS_NAME
SOUP_ADDRESS_PHYSICAL
SOUP_ADDRESS_PORT
SOUP_ADDRESS_SOCKADDR
+SOUP_ADDRESS_PROTOCOL
<SUBSECTION Standard>
SOUP_ADDRESS
SOUP_IS_ADDRESS
@@ -583,6 +584,7 @@ soup_socket_is_connected
<SUBSECTION>
soup_socket_get_local_address
soup_socket_get_remote_address
+soup_socket_get_fd
<SUBSECTION>
SoupSocketIOStatus
soup_socket_read
@@ -611,12 +613,6 @@ SOUP_SOCKET_CLASS
SOUP_IS_SOCKET_CLASS
SOUP_SOCKET_GET_CLASS
SoupSocketClass
-<SUBSECTION Private>
-soup_socket_get_fd
-soup_socket_handshake_async
-soup_socket_handshake_sync
-soup_socket_get_gsocket
-soup_socket_get_iostream
</SECTION>
<SECTION>
@@ -669,8 +665,6 @@ soup_uri_get_fragment
<SUBSECTION Standard>
SOUP_TYPE_URI
soup_uri_get_type
-<SUBSECTION Private>
-uri_decoded_copy
</SECTION>
<SECTION>
@@ -718,8 +712,6 @@ soup_add_completion
soup_add_idle
soup_add_io_watch
soup_add_timeout
-<SUBSECTION>
-soup_ssl_supported
<SUBSECTION Private>
soup_date_copy
SOUP_TYPE_DATE
@@ -734,6 +726,7 @@ SOUP_CHAR_HTTP_SEPARATOR
SOUP_CHAR_URI_GEN_DELIMS
SOUP_CHAR_URI_PERCENT_ENCODED
SOUP_CHAR_URI_SUB_DELIMS
+soup_ssl_supported
</SECTION>
<SECTION>
@@ -950,8 +943,14 @@ soup_multipart_input_stream_next_part
soup_multipart_input_stream_next_part_async
soup_multipart_input_stream_next_part_finish
<SUBSECTION Standard>
+SOUP_IS_MULTIPART_INPUT_STREAM
+SOUP_IS_MULTIPART_INPUT_STREAM_CLASS
+SOUP_MULTIPART_INPUT_STREAM
+SOUP_MULTIPART_INPUT_STREAM_CLASS
+SOUP_MULTIPART_INPUT_STREAM_GET_CLASS
SOUP_TYPE_MULTIPART_INPUT_STREAM
soup_multipart_input_stream_get_type
+SoupMultipartInputStreamPrivate
</SECTION>
<SECTION>
@@ -1014,6 +1013,7 @@ soup_proxy_uri_resolver_get_type
SoupContentSniffer
soup_content_sniffer_new
soup_content_sniffer_sniff
+soup_content_sniffer_get_buffer_size
<SUBSECTION Standard>
SOUP_CONTENT_SNIFFER
SOUP_CONTENT_SNIFFER_CLASS
@@ -1213,4 +1213,38 @@ SOUP_VERSION_2_36
SOUP_VERSION_2_38
SOUP_VERSION_2_40
SOUP_VERSION_2_42
+<SUBSECTION Private>
+SOUP_AVAILABLE_IN_2_24
+SOUP_AVAILABLE_IN_2_26
+SOUP_AVAILABLE_IN_2_28
+SOUP_AVAILABLE_IN_2_30
+SOUP_AVAILABLE_IN_2_32
+SOUP_AVAILABLE_IN_2_34
+SOUP_AVAILABLE_IN_2_36
+SOUP_AVAILABLE_IN_2_38
+SOUP_AVAILABLE_IN_2_40
+SOUP_AVAILABLE_IN_2_42
+SOUP_DEPRECATED_IN_2_24
+SOUP_DEPRECATED_IN_2_24_FOR
+SOUP_DEPRECATED_IN_2_26
+SOUP_DEPRECATED_IN_2_26_FOR
+SOUP_DEPRECATED_IN_2_28
+SOUP_DEPRECATED_IN_2_28_FOR
+SOUP_DEPRECATED_IN_2_30
+SOUP_DEPRECATED_IN_2_30_FOR
+SOUP_DEPRECATED_IN_2_32
+SOUP_DEPRECATED_IN_2_32_FOR
+SOUP_DEPRECATED_IN_2_34
+SOUP_DEPRECATED_IN_2_34_FOR
+SOUP_DEPRECATED_IN_2_36
+SOUP_DEPRECATED_IN_2_36_FOR
+SOUP_DEPRECATED_IN_2_38
+SOUP_DEPRECATED_IN_2_38_FOR
+SOUP_DEPRECATED_IN_2_40
+SOUP_DEPRECATED_IN_2_40_FOR
+SOUP_DEPRECATED_IN_2_42
+SOUP_DEPRECATED_IN_2_42_FOR
+SOUP_ENCODE_VERSION
+SOUP_VERSION_CUR_STABLE
+SOUP_VERSION_PREV_STABLE
</SECTION>