diff options
author | Patrick Griffis <pgriffis@igalia.com> | 2020-09-20 16:32:08 -0700 |
---|---|---|
committer | Patrick Griffis <pgriffis@igalia.com> | 2020-09-20 16:32:41 -0700 |
commit | 223dc77f89c3cf603b4665e99ac9af0d54e87a26 (patch) | |
tree | 6a3d0da5b1e0d72651ebb57332da7b70b7cc5e70 | |
parent | 2ff93c06a00a582b13ae6bbaf8dc52cb3e2a069b (diff) | |
download | libsoup-223dc77f89c3cf603b4665e99ac9af0d54e87a26.tar.gz |
docs: More doc cleanups and organizing
-rw-r--r-- | docs/reference/libsoup-3.0-docs.xml | 14 | ||||
-rw-r--r-- | docs/reference/libsoup-3.0-sections.txt | 51 | ||||
-rw-r--r-- | libsoup/soup-date-utils.c | 7 | ||||
-rw-r--r-- | libsoup/soup-form.c | 1 | ||||
-rw-r--r-- | libsoup/soup-headers.c | 7 | ||||
-rw-r--r-- | libsoup/soup-method.h | 1 | ||||
-rw-r--r-- | libsoup/soup-misc.c | 6 | ||||
-rw-r--r-- | libsoup/soup-status.c | 1 | ||||
-rw-r--r-- | libsoup/soup-tld.c | 1 | ||||
-rw-r--r-- | libsoup/soup-version.c | 1 | ||||
-rw-r--r-- | libsoup/websocket/soup-websocket.c | 1 |
11 files changed, 53 insertions, 38 deletions
diff --git a/docs/reference/libsoup-3.0-docs.xml b/docs/reference/libsoup-3.0-docs.xml index ae42fdfb..479edf8c 100644 --- a/docs/reference/libsoup-3.0-docs.xml +++ b/docs/reference/libsoup-3.0-docs.xml @@ -32,13 +32,13 @@ <xi:include href="xml/soup-message.xml"/> <xi:include href="xml/soup-message-headers.xml"/> <xi:include href="xml/soup-message-body.xml"/> + <xi:include href="xml/soup-headers.xml"/> <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-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"/> </chapter> @@ -86,22 +86,18 @@ <chapter> <title>Utility API</title> - <xi:include href="xml/soup-misc.xml"/> + <xi:include href="xml/soup-date-utils.xml"/> + <xi:include href="xml/soup-tld.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: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:include> </index> <xi:include href="xml/annotation-glossary.xml"> diff --git a/docs/reference/libsoup-3.0-sections.txt b/docs/reference/libsoup-3.0-sections.txt index e9a8631e..925771e8 100644 --- a/docs/reference/libsoup-3.0-sections.txt +++ b/docs/reference/libsoup-3.0-sections.txt @@ -90,6 +90,7 @@ soup_message_starting <SECTION> <FILE>soup-method</FILE> +<TITLE>SoupMethod</TITLE> SOUP_METHOD_OPTIONS SOUP_METHOD_GET SOUP_METHOD_HEAD @@ -164,6 +165,26 @@ soup_message_headers_get_type </SECTION> <SECTION> +<FILE>soup-headers</FILE> +soup_headers_parse_request +soup_headers_parse_response +soup_headers_parse_status_line +soup_headers_parse +<SUBSECTION> +soup_header_parse_list +soup_header_parse_quality_list +soup_header_free_list +soup_header_contains +soup_header_parse_param_list +soup_header_parse_semi_param_list +soup_header_parse_param_list_strict +soup_header_parse_semi_param_list_strict +soup_header_free_param_list +soup_header_g_string_append_param +soup_header_g_string_append_param_quoted +</SECTION> + +<SECTION> <FILE>soup-message-body</FILE> <TITLE>SoupMessageBody</TITLE> SoupMemoryUse @@ -192,6 +213,7 @@ soup_message_body_get_type <SECTION> <FILE>soup-status</FILE> +<TITLE>SoupStatus</TITLE> SOUP_STATUS_IS_TRANSPORT_ERROR SOUP_STATUS_IS_INFORMATIONAL SOUP_STATUS_IS_SUCCESSFUL @@ -588,35 +610,17 @@ soup_uri_get_type </SECTION> <SECTION> -<FILE>soup-misc</FILE> -<TITLE>Soup Miscellaneous Utilities</TITLE> +<FILE>soup-date-utils</FILE> SoupDateFormat soup_date_time_new_from_http_string soup_date_time_to_string <SUBSECTION Private> soup_date_time_is_past -<SUBSECTION> -soup_headers_parse_request -soup_headers_parse_response -soup_headers_parse_status_line -soup_headers_parse -<SUBSECTION> -soup_header_parse_list -soup_header_parse_quality_list -soup_header_free_list -soup_header_contains -soup_header_parse_param_list -soup_header_parse_semi_param_list -soup_header_parse_param_list_strict -soup_header_parse_semi_param_list_strict -soup_header_free_param_list -soup_header_g_string_append_param -soup_header_g_string_append_param_quoted </SECTION> <SECTION> <FILE>soup-form</FILE> -<TITLE>HTML Form Support</TITLE> +<TITLE>SoupForm</TITLE> <SUBSECTION> SOUP_FORM_MIME_TYPE_MULTIPART SOUP_FORM_MIME_TYPE_URLENCODED @@ -749,6 +753,7 @@ soup_cookie_jar_get_type <SECTION> <FILE>soup-multipart</FILE> +<TITLE>SoupMultipart</TITLE> SoupMultipart soup_multipart_new soup_multipart_new_from_message @@ -963,7 +968,7 @@ soup_request_http_get_type <SECTION> <FILE>soup-tld</FILE> -<TITLE>Top Level Domain utils</TITLE> +<TITLE>SoupTLD</TITLE> <SUBSECTION> soup_tld_get_base_domain soup_tld_domain_is_public_suffix @@ -1087,7 +1092,7 @@ SOUP_VERSION_PREV_STABLE <SECTION> <FILE>soup-websocket</FILE> -<TITLE>WebSockets</TITLE> +<TITLE>SoupWebsocket</TITLE> soup_websocket_client_prepare_handshake soup_websocket_client_prepare_handshake_with_extensions soup_websocket_client_verify_handshake @@ -1145,7 +1150,7 @@ soup_websocket_state_get_type <SECTION> <FILE>soup-websocket-extension</FILE> -<TITLE>WebSocket Extensions</TITLE> +<TITLE>SoupWebsocketExtension</TITLE> SoupWebsocketExtension soup_websocket_extension_configure soup_websocket_extension_get_request_params diff --git a/libsoup/soup-date-utils.c b/libsoup/soup-date-utils.c index 7884f068..4b904b7b 100644 --- a/libsoup/soup-date-utils.c +++ b/libsoup/soup-date-utils.c @@ -25,6 +25,13 @@ #include "soup-date-utils-private.h" /** + * SECTION:soup-date-utils + * @section_id: SoupDateTime + * @title: DateTime Utilities + * @short_description: Functions to help working with #GDateTime and HTTP + */ + +/** * soup_date_time_is_past: * @date: a #GDateTime * diff --git a/libsoup/soup-form.c b/libsoup/soup-form.c index 90449dd7..32f1c38e 100644 --- a/libsoup/soup-form.c +++ b/libsoup/soup-form.c @@ -16,6 +16,7 @@ /** * SECTION:soup-form + * @section_id: SoupForm * @short_description: HTML form handling * @see_also: #SoupMultipart * diff --git a/libsoup/soup-headers.c b/libsoup/soup-headers.c index bc68d8bd..fbe1e986 100644 --- a/libsoup/soup-headers.c +++ b/libsoup/soup-headers.c @@ -17,6 +17,13 @@ #include "soup.h" /** + * SECTION:soup-headers + * @section_id: SoupHeaders + * @title: SoupHeaders + * @short_description: Functions to help working with HTTP Headers + */ + +/** * soup_headers_parse: * @str: the header string (including the Request-Line or Status-Line, * but not the trailing blank line) diff --git a/libsoup/soup-method.h b/libsoup/soup-method.h index b5a002d8..39d92b73 100644 --- a/libsoup/soup-method.h +++ b/libsoup/soup-method.h @@ -11,6 +11,7 @@ G_BEGIN_DECLS /** * SECTION:soup-method + * @section_id: SoupMethod * @short_description: HTTP method definitions * * soup-method.h contains a number of defines for standard HTTP and diff --git a/libsoup/soup-misc.c b/libsoup/soup-misc.c index 076e13dd..34bbf241 100644 --- a/libsoup/soup-misc.c +++ b/libsoup/soup-misc.c @@ -14,12 +14,6 @@ #include "soup-misc.h" /** - * SECTION:soup-misc - * @short_description: Miscellaneous functions - * - **/ - -/** * soup_str_case_hash: * @key: ASCII string to hash * diff --git a/libsoup/soup-status.c b/libsoup/soup-status.c index df608f03..d4ed5c41 100644 --- a/libsoup/soup-status.c +++ b/libsoup/soup-status.c @@ -14,6 +14,7 @@ /** * SECTION:soup-status + * @section_id: SoupStatus * @short_description: HTTP (and libsoup) status codes * **/ diff --git a/libsoup/soup-tld.c b/libsoup/soup-tld.c index a1e9bad4..9025c293 100644 --- a/libsoup/soup-tld.c +++ b/libsoup/soup-tld.c @@ -19,6 +19,7 @@ /** * SECTION:soup-tld + * @section_id: SoupTLD * @short_description: Top-Level Domain Utilities * * These functions can be used to parse hostnames to attempt to determine diff --git a/libsoup/soup-version.c b/libsoup/soup-version.c index 99c3b530..00bd9fc3 100644 --- a/libsoup/soup-version.c +++ b/libsoup/soup-version.c @@ -13,6 +13,7 @@ /** * SECTION:soup-version + * @section_id: SoupVersion * @short_description: Variables and functions to check the libsoup version **/ diff --git a/libsoup/websocket/soup-websocket.c b/libsoup/websocket/soup-websocket.c index 45ec0925..e7f29f49 100644 --- a/libsoup/websocket/soup-websocket.c +++ b/libsoup/websocket/soup-websocket.c @@ -33,6 +33,7 @@ /** * SECTION:soup-websocket + * @section_id: SoupWebsocket * @short_description: The WebSocket Protocol * @see_also: soup_session_websocket_connect_async(), * soup_server_add_websocket_handler() |