[gssdp] doc: Various cleanups



commit 4b2afd15b2070bcc094cda5fdaf4853b1277e02f
Author: Jens Georg <mail jensge org>
Date:   Wed May 12 23:58:21 2021 +0200

    doc: Various cleanups

 doc/gssdp-docs.xml      | 10 ++++++++--
 doc/gssdp-sections.txt  |  3 +++
 libgssdp/gssdp-client.c |  9 +++++++--
 3 files changed, 18 insertions(+), 4 deletions(-)
---
diff --git a/doc/gssdp-docs.xml b/doc/gssdp-docs.xml
index 68f563b..bb631df 100644
--- a/doc/gssdp-docs.xml
+++ b/doc/gssdp-docs.xml
@@ -61,14 +61,20 @@
     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
   </index>
 
-  <index id="api-index-deprecated" role="deprecated">
+  <index id="api-index-deprecated">
     <title>Index of deprecated symbols</title>
     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
   </index>
 
-  <index id="api-index-1-1-1" role="1.1.1">
+  <index id="api-index-1-1-1">
     <title>Index of new symbols in 1.1.1</title>
     <xi:include href="xml/api-index-1.1.1.xml"><xi:fallback /></xi:include>
   </index>
 
+  <index id="api-index-1-2-3">
+    <title>Index of new symbols in 1.2.3</title>
+    <xi:include href="xml/api-index-1.2.3.xml"><xi:fallback /></xi:include>
+  </index>
+
+
 </book>
diff --git a/doc/gssdp-sections.txt b/doc/gssdp-sections.txt
index 779ca31..4fab17a 100644
--- a/doc/gssdp-sections.txt
+++ b/doc/gssdp-sections.txt
@@ -11,6 +11,7 @@ gssdp_client_get_interface
 gssdp_client_get_host_ip
 gssdp_client_set_network
 gssdp_client_get_network
+gssdp_client_get_address_mask
 gssdp_client_get_active
 gssdp_client_get_address
 gssdp_client_get_family
@@ -36,6 +37,8 @@ GSSDP_IS_CLIENT_CLASS
 GSSDP_CLIENT_GET_CLASS
 <SUBSECTION Private>
 GSSDPClientPrivate
+GSSDPPktinfo6Message
+GSSDP_TYPE_PKTINFO6_MESSAGE
 </SECTION>
 
 <SECTION>
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)


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]