Commit ad4447e5 authored by Patrick Griffis's avatar Patrick Griffis

docs: More doc fixes

parent 6339979c
Pipeline #215238 passed with stages
in 2 minutes and 6 seconds
......@@ -406,7 +406,7 @@ to do next. The <structfield>status_code</structfield> and
status and textual status response from the server.
<structfield>response_headers</structfield> contains the response
headers, which you can investigate using <link
linkend="soup-message-headers-get"><function>soup_message_headers_get</function></link>
linkend="soup-message-headers-get-list"><function>soup_message_headers_get_list</function></link>
and <link
linkend="soup-message-headers-foreach"><function>soup_message_headers_foreach</function></link>.
</para>
......
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
<book xmlns="http://docbook.org/ns/docbook" id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<book xmlns="http://docbook.org/ns/docbook" id="index"
xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
<title>libsoup Reference Manual</title>
<releaseinfo>
......@@ -18,12 +19,15 @@
</chapter>
<chapter>
<title>Core API</title>
<xi:include href="xml/soup-auth.xml"/>
<xi:include href="xml/soup-auth-domain.xml"/>
<xi:include href="xml/soup-auth-domain-basic.xml"/>
<xi:include href="xml/soup-auth-domain-digest.xml"/>
<xi:include href="xml/soup-cache.xml"/>
<title>Request API</title>
<xi:include href="xml/soup-request.xml"/>
<xi:include href="xml/soup-request-http.xml"/>
<xi:include href="xml/soup-request-file.xml"/>
<xi:include href="xml/soup-request-data.xml"/>
</chapter>
<chapter>
<title>Core HTTP API</title>
<xi:include href="xml/soup-cookie.xml"/>
<xi:include href="xml/soup-message.xml"/>
<xi:include href="xml/soup-message-headers.xml"/>
......@@ -31,35 +35,42 @@
<xi:include href="xml/soup-method.xml"/>
<xi:include href="xml/soup-multipart.xml"/>
<xi:include href="xml/soup-multipart-input-stream.xml"/>
<xi:include href="xml/soup-request.xml"/>
<xi:include href="xml/soup-request-http.xml"/>
<xi:include href="xml/soup-request-file.xml"/>
<xi:include href="xml/soup-request-data.xml"/>
<xi:include href="xml/soup-server.xml"/>
<xi:include href="xml/soup-session.xml"/>
<xi:include href="xml/soup-status.xml"/>
<xi:include href="xml/soup-tld.xml"/>
<xi:include href="xml/soup-uri.xml"/>
<xi:include href="xml/soup-version.xml"/>
</chapter>
<chapter>
<title>Additional Features</title>
<xi:include href="xml/soup-session-feature.xml"/>
<xi:include href="xml/soup-auth-manager.xml"/>
<xi:include href="xml/soup-content-decoder.xml"/>
<xi:include href="xml/soup-content-sniffer.xml"/>
<xi:include href="xml/soup-logger.xml"/>
<section>
<title>Cookie Support</title>
<xi:include href="xml/soup-cookie-jar.xml"/>
<xi:include href="xml/soup-cookie-jar-text.xml"/>
<xi:include href="xml/soup-cookie-jar-db.xml"/>
<title>Authentication</title>
<xi:include href="xml/soup-auth-manager.xml"/>
<xi:include href="xml/soup-auth.xml"/>
<xi:include href="xml/soup-auth-domain.xml"/>
<xi:include href="xml/soup-auth-domain-basic.xml"/>
<xi:include href="xml/soup-auth-domain-digest.xml"/>
</section>
<section>
<title>Caching</title>
<xi:include href="xml/soup-cache.xml"/>
</section>
<section>
<title>Cookie Storage Support</title>
<xi:include href="xml/soup-cookie-jar.xml"/>
<xi:include href="xml/soup-cookie-jar-text.xml"/>
<xi:include href="xml/soup-cookie-jar-db.xml"/>
</section>
<section>
<title>HSTS Support</title>
<xi:include href="xml/soup-hsts-enforcer.xml"/>
<xi:include href="xml/soup-hsts-enforcer-db.xml"/>
<title>HSTS Support</title>
<xi:include href="xml/soup-hsts-enforcer.xml"/>
<xi:include href="xml/soup-hsts-enforcer-db.xml"/>
<xi:include href="xml/soup-hsts-policy.xml"/>
</section>
</chapter>
......@@ -67,23 +78,35 @@
<title>Web Services APIs</title>
<xi:include href="xml/soup-form.xml"/>
<section>
<title>WebSocket Support</title>
<xi:include href="xml/soup-websocket.xml"/>
<xi:include href="xml/soup-websocket-extension.xml"/>
<title>WebSocket Support</title>
<xi:include href="xml/soup-websocket.xml"/>
<xi:include href="xml/soup-websocket-extension.xml"/>
</section>
</chapter>
<chapter>
<title>Utility API</title>
<xi:include href="xml/soup-misc.xml"/>
<xi:include href="xml/soup-version.xml"/>
</chapter>
<index id="api-index-full">
<title>Index of all symbols</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
<xi:include href="xml/api-index-full.xml">
<xi:fallback />
</xi:include>
</index>
<index id="api-index-deprecated" role="deprecated">
<title>Index of deprecated symbols</title>
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
<xi:include href="xml/api-index-deprecated.xml">
<xi:fallback />
</xi:include>
</index>
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
<xi:include href="xml/annotation-glossary.xml">
<xi:fallback />
</xi:include>
</book>
......@@ -28,6 +28,9 @@ ignore_headers = [
'soup-socket-private.h',
'soup-websocket-extension-manager-private.h',
'soup-misc.h',
'soup-date-utils-private.h',
'soup-resources.h',
'soup-private-enum-types.h',
]
mkdb_args = [
......
......@@ -266,7 +266,7 @@ to tell <application>libsoup</application> that you'll be using
chunked encoding. Then call <link
linkend="soup-message-body-append"><function>soup_message_body_append</function></link>
(or <link
linkend="soup-message-body-append-buffer"><function>soup_message_body_append_buffer</function></link>)
linkend="soup-message-body-append-bytes"><function>soup_message_body_append_bytes</function></link>)
on <literal>msg->response_body</literal> with each chunk of the
response body as it becomes available, and call <link
linkend="soup-message-body-complete"><function>soup_message_body_complete</function></link>
......
......@@ -537,7 +537,7 @@ soup_message_headers_iter_next (SoupMessageHeadersIter *iter,
*
* Calls @func once for each header value in @hdrs.
*
* Beware that unlike soup_message_headers_get(), this processes the
* Beware that unlike soup_message_headers_get_list(), this processes the
* headers in exactly the way they were added, rather than
* concatenating multiple same-named headers into a single value.
* (This is intentional; it ensures that if you call
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment