summaryrefslogtreecommitdiff
path: root/libsoup/websocket
diff options
context:
space:
mode:
authorPatrick Griffis <pgriffis@igalia.com>2020-09-19 19:52:35 -0700
committerPatrick Griffis <pgriffis@igalia.com>2020-09-20 12:27:32 -0700
commit7525c97f85d4b6b21039ee51065b02d4e20e6a2b (patch)
treec96dd156541e602eb914f6505b0ef110fe149c63 /libsoup/websocket
parent6af11afc7fa8681e1dbdfc8cca7fe7a15f54f7c8 (diff)
downloadlibsoup-7525c97f85d4b6b21039ee51065b02d4e20e6a2b.tar.gz
docs: Mass docs fixups
Diffstat (limited to 'libsoup/websocket')
-rw-r--r--libsoup/websocket/soup-websocket-extension-deflate.c7
-rw-r--r--libsoup/websocket/soup-websocket-extension-manager.c5
-rw-r--r--libsoup/websocket/soup-websocket-extension.c1
-rw-r--r--libsoup/websocket/soup-websocket-extension.h1
-rw-r--r--libsoup/websocket/soup-websocket.c2
5 files changed, 6 insertions, 10 deletions
diff --git a/libsoup/websocket/soup-websocket-extension-deflate.c b/libsoup/websocket/soup-websocket-extension-deflate.c
index c343f1d0..77e6c1d5 100644
--- a/libsoup/websocket/soup-websocket-extension-deflate.c
+++ b/libsoup/websocket/soup-websocket-extension-deflate.c
@@ -66,11 +66,8 @@ typedef struct {
Inflater inflater;
} SoupWebsocketExtensionDeflatePrivate;
-/*
- * SECTION:soup-websocket-extension-deflate
- * @title: SoupWebsocketExtensionDeflate
- * @short_description: A permessage-deflate WebSocketExtension
- * @see_also: #SoupWebsocketExtension
+/**
+ * SoupWebsocketExtensionDeflate:
*
* A SoupWebsocketExtensionDeflate is a #SoupWebsocketExtension
* implementing permessage-deflate (RFC 7692).
diff --git a/libsoup/websocket/soup-websocket-extension-manager.c b/libsoup/websocket/soup-websocket-extension-manager.c
index 90ca105d..f213d6d6 100644
--- a/libsoup/websocket/soup-websocket-extension-manager.c
+++ b/libsoup/websocket/soup-websocket-extension-manager.c
@@ -33,10 +33,7 @@
#include "soup-websocket-extension-manager-private.h"
/**
- * SECTION:soup-websocket-extension-manager
- * @title: SoupWebsocketExtensionManager
- * @short_description: WebSocket extensions manager
- * @see_also: #SoupSession, #SoupWebsocketExtension
+ * SoupWebsocketExtensionManager:
*
* SoupWebsocketExtensionManager is the #SoupSessionFeature that handles WebSockets
* extensions for a #SoupSession.
diff --git a/libsoup/websocket/soup-websocket-extension.c b/libsoup/websocket/soup-websocket-extension.c
index 91ae6951..68d2bbb4 100644
--- a/libsoup/websocket/soup-websocket-extension.c
+++ b/libsoup/websocket/soup-websocket-extension.c
@@ -38,6 +38,7 @@
/**
* SoupWebsocketExtensionClass:
+ * @name: the name of the extension
* @parent_class: the parent class
* @configure: called to configure the extension with the given parameters
* @get_request_params: called by the client to build the request header.
diff --git a/libsoup/websocket/soup-websocket-extension.h b/libsoup/websocket/soup-websocket-extension.h
index 7d2d3686..7f2cfa1c 100644
--- a/libsoup/websocket/soup-websocket-extension.h
+++ b/libsoup/websocket/soup-websocket-extension.h
@@ -55,6 +55,7 @@ struct _SoupWebsocketExtensionClass {
GBytes *payload,
GError **error);
+ /* <private> */
gpointer padding[6];
};
diff --git a/libsoup/websocket/soup-websocket.c b/libsoup/websocket/soup-websocket.c
index 13b56474..45ec0925 100644
--- a/libsoup/websocket/soup-websocket.c
+++ b/libsoup/websocket/soup-websocket.c
@@ -625,7 +625,7 @@ process_extensions (SoupMessage *msg,
* only requests containing valid supported extensions in
* "Sec-WebSocket-Extensions" header will be accepted.
*
- * Normally soup_websocket_server_process_handshake_with_extensioins()
+ * Normally soup_websocket_server_process_handshake_with_extensions()
* will take care of this for you, and if you use
* soup_server_add_websocket_handler() to handle accepting WebSocket
* connections, it will call that for you. However, this function may