diff options
author | Patrick Griffis <pgriffis@igalia.com> | 2020-09-20 13:17:21 -0700 |
---|---|---|
committer | Patrick Griffis <pgriffis@igalia.com> | 2020-09-20 13:17:21 -0700 |
commit | ad4447e55efb1121cade70601cf46ad238e3d9a9 (patch) | |
tree | 05e4ae668e82b967cefe0c49e702b2a90eec6f32 /docs | |
parent | 6339979cda30a6efaddb7ce3d3e20c98a16225c8 (diff) | |
download | libsoup-ad4447e55efb1121cade70601cf46ad238e3d9a9.tar.gz |
docs: More doc fixes
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/client-howto.xml | 2 | ||||
-rw-r--r-- | docs/reference/libsoup-3.0-docs.xml | 75 | ||||
-rw-r--r-- | docs/reference/meson.build | 3 | ||||
-rw-r--r-- | docs/reference/server-howto.xml | 2 |
4 files changed, 54 insertions, 28 deletions
diff --git a/docs/reference/client-howto.xml b/docs/reference/client-howto.xml index 0eb78b55..2426a249 100644 --- a/docs/reference/client-howto.xml +++ b/docs/reference/client-howto.xml @@ -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> diff --git a/docs/reference/libsoup-3.0-docs.xml b/docs/reference/libsoup-3.0-docs.xml index 79bf610d..ae42fdfb 100644 --- a/docs/reference/libsoup-3.0-docs.xml +++ b/docs/reference/libsoup-3.0-docs.xml @@ -1,6 +1,7 @@ <?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> diff --git a/docs/reference/meson.build b/docs/reference/meson.build index ba1e84fc..c0fe7d6d 100644 --- a/docs/reference/meson.build +++ b/docs/reference/meson.build @@ -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 = [ diff --git a/docs/reference/server-howto.xml b/docs/reference/server-howto.xml index 074909cd..f24d61ea 100644 --- a/docs/reference/server-howto.xml +++ b/docs/reference/server-howto.xml @@ -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> |