summaryrefslogtreecommitdiff
path: root/libsoup/server
diff options
context:
space:
mode:
authorPatrick Griffis <pgriffis@igalia.com>2020-11-03 13:35:14 -0600
committerPatrick Griffis <pgriffis@igalia.com>2020-11-03 13:35:14 -0600
commit730944bb1122a60443ad877dd2b29b8f5a356240 (patch)
treecb3c3b784e43c607b2637c146930366681610576 /libsoup/server
parent19d13a303b80c31e2fba667e0f1a292ff56fc332 (diff)
downloadlibsoup-730944bb1122a60443ad877dd2b29b8f5a356240.tar.gz
docs: Reach 100% documentation coverage
Diffstat (limited to 'libsoup/server')
-rw-r--r--libsoup/server/soup-auth-domain-basic.c6
-rw-r--r--libsoup/server/soup-auth-domain-digest.c6
-rw-r--r--libsoup/server/soup-auth-domain.c6
-rw-r--r--libsoup/server/soup-message-body.c2
-rw-r--r--libsoup/server/soup-server-message.c6
-rw-r--r--libsoup/server/soup-server.c20
6 files changed, 46 insertions, 0 deletions
diff --git a/libsoup/server/soup-auth-domain-basic.c b/libsoup/server/soup-auth-domain-basic.c
index 44944a26..1fa37563 100644
--- a/libsoup/server/soup-auth-domain-basic.c
+++ b/libsoup/server/soup-auth-domain-basic.c
@@ -22,6 +22,12 @@
* cleartext password) authentication.
**/
+/**
+ * SoupAuthDomainBasic:
+ *
+ * Subclass of #SoupAuthDomain for Basic authentication.
+ */
+
enum {
PROP_0,
diff --git a/libsoup/server/soup-auth-domain-digest.c b/libsoup/server/soup-auth-domain-digest.c
index da3e674c..1bce5770 100644
--- a/libsoup/server/soup-auth-domain-digest.c
+++ b/libsoup/server/soup-auth-domain-digest.c
@@ -24,6 +24,12 @@
* authentication.
**/
+/**
+ * SoupAuthDomainDigest:
+ *
+ * Subclass of #SoupAuthDomain for Digest authentication.
+ */
+
enum {
PROP_0,
diff --git a/libsoup/server/soup-auth-domain.c b/libsoup/server/soup-auth-domain.c
index 5fba8eb4..1b7da219 100644
--- a/libsoup/server/soup-auth-domain.c
+++ b/libsoup/server/soup-auth-domain.c
@@ -39,6 +39,12 @@
* those requests that don't need it.
**/
+/**
+ * SoupAuthDomain:
+ *
+ * Class managing authentication for #SoupServer.
+ */
+
enum {
PROP_0,
diff --git a/libsoup/server/soup-message-body.c b/libsoup/server/soup-message-body.c
index 87e583f3..e9925011 100644
--- a/libsoup/server/soup-message-body.c
+++ b/libsoup/server/soup-message-body.c
@@ -33,6 +33,8 @@
* @SOUP_MEMORY_COPY: The passed-in data belongs to the caller and
* libsoup will copy it into new memory leaving the caller free
* to reuse the original memory.
+ *
+ * The lifetime of the memory being passed.
**/
/**
diff --git a/libsoup/server/soup-server-message.c b/libsoup/server/soup-server-message.c
index 1f2e8515..7406d757 100644
--- a/libsoup/server/soup-server-message.c
+++ b/libsoup/server/soup-server-message.c
@@ -34,6 +34,12 @@
* the response.
**/
+/**
+ * SoupServerMessage:
+ *
+ * Class represnting an HTTP request and response pair for a server.
+ */
+
struct _SoupServerMessage {
GObject parent;
diff --git a/libsoup/server/soup-server.c b/libsoup/server/soup-server.c
index 86357f9f..e9243ab1 100644
--- a/libsoup/server/soup-server.c
+++ b/libsoup/server/soup-server.c
@@ -120,6 +120,12 @@
* #GMainContext.
*/
+/**
+ * SoupServer:
+ *
+ * Class implementing an HTTP server.
+ */
+
enum {
REQUEST_STARTED,
REQUEST_READ,
@@ -595,6 +601,13 @@ soup_server_class_init (SoupServerClass *server_class)
*
* Since: 2.68
**/
+ /**
+ * SOUP_SERVER_ADD_WEBSOCKET_EXTENSION: (skip)
+ *
+ * Alias for %SoupServer:add-websocket-extension
+ *
+ * Since: 2.68
+ */
g_object_class_install_property (
object_class, PROP_ADD_WEBSOCKET_EXTENSION,
g_param_spec_gtype (SOUP_SERVER_ADD_WEBSOCKET_EXTENSION,
@@ -610,6 +623,13 @@ soup_server_class_init (SoupServerClass *server_class)
*
* Since: 2.68
**/
+ /**
+ * SOUP_SERVER_REMOVE_WEBSOCKET_EXTENSION: (skip)
+ *
+ * Alias for %SoupServer:remove-websocket-extension
+ *
+ * Since: 2.68
+ */
g_object_class_install_property (
object_class, PROP_REMOVE_WEBSOCKET_EXTENSION,
g_param_spec_gtype (SOUP_SERVER_REMOVE_WEBSOCKET_EXTENSION,