GNOME.org
 

[libsoup] docs: Misc fixups

commit 313d6624dea3667273925537f358cd9e9c174fab
Author: Patrick Griffis <pgriffis igalia com>
Date:   Tue Dec 8 14:45:22 2020 -0600

    docs: Misc fixups

 libsoup/auth/soup-auth-manager.c               |  4 ++--
 libsoup/content-decoder/soup-content-decoder.c |  6 ++----
 libsoup/server/soup-message-body.c             |  5 +----
 libsoup/server/soup-server.c                   |  6 +-----
 libsoup/soup-form.c                            | 11 +++++++++--
 libsoup/soup-logger.c                          |  2 +-
 libsoup/soup-message.c                         |  5 ++---
 libsoup/soup-multipart.c                       |  9 ++++-----
 libsoup/soup-session.c                         |  9 +--------
 9 files changed, 23 insertions(+), 34 deletions(-)
---
diff --git a/libsoup/auth/soup-auth-manager.c b/libsoup/auth/soup-auth-manager.c
index 1aa45e85..5e602dce 100644
--- a/libsoup/auth/soup-auth-manager.c
+++ b/libsoup/auth/soup-auth-manager.c
@@ -142,8 +142,8 @@ soup_auth_manager_class_init (SoupAuthManagerClass *auth_manager_class)
         * Emitted when the manager requires the application to
         * provide authentication credentials.
         *
-        * #SoupSession connects to this signal and emits its own
-        * #SoupSession::authenticate signal when it is emitted, so
+        * #SoupMessage connects to this signal and emits its own
+        * #SoupMessage::authenticate signal when it is emitted, so
         * you shouldn't need to use this signal directly.
         */
        signals[AUTHENTICATE] =
diff --git a/libsoup/content-decoder/soup-content-decoder.c b/libsoup/content-decoder/soup-content-decoder.c
index abbf7f0d..05ecc90c 100644
--- a/libsoup/content-decoder/soup-content-decoder.c
+++ b/libsoup/content-decoder/soup-content-decoder.c
@@ -29,10 +29,8 @@
  *
  * A #SoupContentDecoder will automatically be
  * added to the session by default. (You can use
- * %SOUP_SESSION_REMOVE_FEATURE_BY_TYPE at construct time if you don't
- * want this.) If you are using one of the deprecated #SoupSession
- * subclasses, you can add a #SoupContentDecoder to your session with
- * soup_session_add_feature() or soup_session_add_feature_by_type().
+ * soup_session_remove_feature_by_type() if you don't
+ * want this.)
  *
  * If #SoupContentDecoder successfully decodes the Content-Encoding,
  * the message body will contain the decoded data; however, the message headers
diff --git a/libsoup/server/soup-message-body.c b/libsoup/server/soup-message-body.c
index d31121ef..adf706ac 100644
--- a/libsoup/server/soup-message-body.c
+++ b/libsoup/server/soup-message-body.c
@@ -101,10 +101,7 @@ soup_message_body_new (void)
  * be discarded after being written like in the server-side
  * #SoupMessage response_body case, because the request body needs to
  * be kept around in case the request needs to be sent a second time
- * due to redirection or authentication. However, if you set the
- * %SOUP_MESSAGE_CAN_REBUILD flag on the message, then the chunks will
- * be discarded, and you will be responsible for recreating the
- * request body after the #SoupMessage::restarted signal is emitted.
+ * due to redirection or authentication.
  *
  * Since: 2.24
  **/
diff --git a/libsoup/server/soup-server.c b/libsoup/server/soup-server.c
index 3c1bad86..f6cddf9c 100644
--- a/libsoup/server/soup-server.c
+++ b/libsoup/server/soup-server.c
@@ -1924,8 +1924,6 @@ soup_server_unpause_message (SoupServer        *server,
  * a new #SoupWebsocketExtension of type @extension_type will be created
  * to handle the request.
  *
- * You can also add support for a WebSocket extension to the server at
- * construct time by using the #SoupServer:add-websocket-extension property.
  * Note that #SoupWebsocketExtensionDeflate is supported by default, use
  * soup_server_remove_websocket_extension() if you want to disable it.
  *
@@ -1953,9 +1951,7 @@ soup_server_add_websocket_extension (SoupServer *server, GType extension_type)
  * @extension_type: a #GType
  *
  * Removes support for WebSocket extension of type @extension_type (or any subclass of
- * @extension_type) from @server. You can also remove extensions enabled by default
- * from the server at construct time by using the %SOUP_SERVER_REMOVE_WEBSOCKET_EXTENSION
- * property.
+ * @extension_type) from @server.
  *
  * Since: 2.68
  */
diff --git a/libsoup/soup-form.c b/libsoup/soup-form.c
index c0391444..b22df669 100644
--- a/libsoup/soup-form.c
+++ b/libsoup/soup-form.c
@@ -248,6 +248,8 @@ encode_pair (GString *str, const char *name, const char *value)
  * soup_form_encode_datalist().
  *
  * Return value: the encoded form
+ *
+ * See also: soup_message_new_from_encoded_form()
  **/
 char *
 soup_form_encode (const char *first_field, ...)
@@ -277,6 +279,8 @@ soup_form_encode (const char *first_field, ...)
  * ordering of the form fields, use soup_form_encode_datalist().
  *
  * Return value: the encoded form
+ *
+ * See also: soup_message_new_from_encoded_form()
  **/
 char *
 soup_form_encode_hash (GHashTable *form_data_set)
@@ -307,6 +311,8 @@ datalist_encode_foreach (GQuark key_id, gpointer value, gpointer str)
  * of the form elements, which may be required in some situations.
  *
  * Return value: the encoded form
+ *
+ * See also: soup_message_new_from_encoded_form()
  **/
 char *
 soup_form_encode_datalist (GData **form_data_set)
@@ -323,10 +329,11 @@ soup_form_encode_datalist (GData **form_data_set)
  * @args: pointer to additional values, as in soup_form_encode()
  *
  * See soup_form_encode(). This is mostly an internal method, used by
- * various other methods such as soup_uri_set_query_from_fields() and
- * soup_form_request_new().
+ * various other methods such as soup_form_encode().
  *
  * Return value: the encoded form
+ *
+ * See also: soup_message_new_from_encoded_form()
  **/
 char *
 soup_form_encode_valist (const char *first_field, va_list args)
diff --git a/libsoup/soup-logger.c b/libsoup/soup-logger.c
index 0ac5bb08..caa409dc 100644
--- a/libsoup/soup-logger.c
+++ b/libsoup/soup-logger.c
@@ -76,7 +76,7 @@
  * body is read from the network (from the #SoupMessage::got-body or
  * #SoupMessage::got-informational signal), which means that the
  * #SoupMessage::got-headers signal, and anything triggered off it
- * (such as #SoupSession::authenticate) will be emitted
+ * (such as #SoupMessage::authenticate) will be emitted
  * <emphasis>before</emphasis> the response headers are actually
  * logged.
  *
diff --git a/libsoup/soup-message.c b/libsoup/soup-message.c
index 4ede71c1..96685b50 100644
--- a/libsoup/soup-message.c
+++ b/libsoup/soup-message.c
@@ -1370,7 +1370,7 @@ soup_message_cleanup_response (SoupMessage *msg)
  *   the credentials cache for this message, neither to use cached credentials
  *   to automatically authenticate this message nor to cache the credentials
  *   after the message is successfully authenticated. This applies to both server
- *   and proxy authentication. Note that #SoupSession::authenticate signal will
+ *   and proxy authentication. Note that #SoupMessage::authenticate signal will
  *   be emitted, if you want to disable authentication for a message use
  *   soup_message_disable_feature() passing #SOUP_TYPE_AUTH_MANAGER instead. Since 2.58
  *
@@ -1576,8 +1576,7 @@ soup_message_is_keepalive (SoupMessage *msg)
  * @uri: the new #GUri
  *
  * Sets @msg's URI to @uri. If @msg has already been sent and you want
- * to re-send it with the new URI, you need to call
- * soup_session_requeue_message().
+ * to re-send it with the new URI, you need to send it again.
  **/
 void
 soup_message_set_uri (SoupMessage *msg, GUri *uri)
diff --git a/libsoup/soup-multipart.c b/libsoup/soup-multipart.c
index f2f95b31..b383a950 100644
--- a/libsoup/soup-multipart.c
+++ b/libsoup/soup-multipart.c
@@ -83,9 +83,10 @@ generate_boundary (void)
  * Creates a new empty #SoupMultipart with a randomly-generated
  * boundary string. Note that @mime_type must be the full MIME type,
  * including "multipart/".
- *
+ * 
  * Return value: a new empty #SoupMultipart of the given @mime_type
  *
+ * See also: soup_message_new_from_multipart()
  * Since: 2.26
  **/
 SoupMultipart *
@@ -325,8 +326,7 @@ soup_multipart_append_part (SoupMultipart      *multipart,
  *
  * Adds a new MIME part containing @data to @multipart, using
  * "Content-Disposition: form-data", as per the HTML forms
- * specification. See soup_form_request_new_from_multipart() for more
- * details.
+ * specification.
  *
  * Since: 2.26
  **/ 
@@ -352,8 +352,7 @@ soup_multipart_append_form_string (SoupMultipart *multipart,
  *
  * Adds a new MIME part containing @body to @multipart, using
  * "Content-Disposition: form-data", as per the HTML forms
- * specification. See soup_form_request_new_from_multipart() for more
- * details.
+ * specification.
  *
  * Since: 2.26
  **/ 
diff --git a/libsoup/soup-session.c b/libsoup/soup-session.c
index 256bb63f..c2db87ac 100644
--- a/libsoup/soup-session.c
+++ b/libsoup/soup-session.c
@@ -52,8 +52,7 @@
  * Additional #SoupSession functionality is provided by
  * #SoupSessionFeature objects, which can be added to a session with
  * soup_session_add_feature() or soup_session_add_feature_by_type()
- * (or at construct time with the %SOUP_SESSION_ADD_FEATURE_BY_TYPE
- * pseudo-property). For example, #SoupLogger provides support for
+ * For example, #SoupLogger provides support for
  * logging HTTP traffic, #SoupContentDecoder provides support for
  * compressed response handling, and #SoupContentSniffer provides
  * support for HTML5-style response body content sniffing.
@@ -2291,9 +2290,6 @@ soup_session_class_init (SoupSessionClass *session_class)
         * Setting this to %FALSE (when it was previously %TRUE) will
         * clear the #SoupSession:tls-database field.
         *
-        * See #SoupSession:ssl-strict for more information on how
-        * https certificate validation is handled.
-        *
         * Since: 2.38
         **/
        g_object_class_install_property (
@@ -2315,9 +2311,6 @@ soup_session_class_init (SoupSessionClass *session_class)
         * this property to be set to a #GTlsDatabase corresponding to
         * the indicated file or system default.
         *
-        * See #SoupSession:ssl-strict for more information on how
-        * https certificate validation is handled.
-        *
         * Since: 2.38
         **/
        g_object_class_install_property (
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]