summaryrefslogtreecommitdiff
path: root/libgssdp
diff options
context:
space:
mode:
authorJens Georg <mail@jensge.org>2021-05-12 23:58:21 +0200
committerJens Georg <mail@jensge.org>2021-05-12 23:59:59 +0200
commit4b2afd15b2070bcc094cda5fdaf4853b1277e02f (patch)
tree02907e5bfbd67160ccae6b7991c380f749ad28f6 /libgssdp
parentf3362e64e44bd492b9588cace167d4ed23bcfae8 (diff)
downloadgssdp-4b2afd15b2070bcc094cda5fdaf4853b1277e02f.tar.gz
doc: Various cleanups
Diffstat (limited to 'libgssdp')
-rw-r--r--libgssdp/gssdp-client.c9
1 files changed, 7 insertions, 2 deletions
diff --git a/libgssdp/gssdp-client.c b/libgssdp/gssdp-client.c
index 5724f04..2cdb027 100644
--- a/libgssdp/gssdp-client.c
+++ b/libgssdp/gssdp-client.c
@@ -786,8 +786,13 @@ gssdp_client_new_with_port (const char *iface,
* @client: A #GSSDPClient
* @server_id: The server ID
*
- * Sets the server ID of @client to @server_id.
- **/
+ * Sets the server ID of @client to @server_id. This string is used as the
+ * "Server:" identification header for SSDP discovery and response packets
+ * and "User-Agent" header for searches.
+ *
+ * By default, GSSDP will generate a header conforming to the requirements
+ * defined in the UDA documents: OS/Version UPnP/Version GSSDP/Version.
+ */
void
gssdp_client_set_server_id (GSSDPClient *client,
const char *server_id)