[gupnp] docs: Minor fixes



commit 5b7797b49f84d93ba9c20f241ef4bec73657650c
Author: Jens Georg <mail jensge org>
Date:   Tue Jun 14 08:01:39 2022 +0200

    docs: Minor fixes
    
     - glib doc urls
     - Updated urlmap.js
     - Minor doc visual fixes

 doc/gupnp.toml.in              |  9 +++++++--
 doc/urlmap.js                  |  4 ++++
 libgupnp/gupnp-service-proxy.c |  4 ++--
 libgupnp/gupnp-xml-doc.c       | 13 ++-----------
 4 files changed, 15 insertions(+), 15 deletions(-)
---
diff --git a/doc/gupnp.toml.in b/doc/gupnp.toml.in
index d604600..ced1f6f 100644
--- a/doc/gupnp.toml.in
+++ b/doc/gupnp.toml.in
@@ -7,7 +7,7 @@ website_url = "https://gupnp.org";
 logo_url = "gupnp-logo-short.svg"
 license = "LGPL-2.1-or-later"
 description = "UPnP implementation using GObject"
-dependencies = [ "GObject-2.0", "GSSDP-1.6", "Soup-3.0", "libxml2-2.0" ]
+dependencies = [ "GLib-2.0", "GObject-2.0", "GSSDP-1.6", "Soup-3.0", "libxml2-2.0" ]
 devhelp = true
 search_index = true
 authors = "The GUPnP developers"
@@ -19,10 +19,15 @@ show_index_summary = true
 [source-location]
 base_url = "https://gitlab.gnome.org/GNOME/gupnp/-/blob/master";
 
+[dependencies."GLib-2.0"]
+name = "GLib"
+description = "The base type system library"
+docs_url = "https://docs.gtk.org/glib/";
+
 [dependencies."GObject-2.0"]
 name = "GObject"
 description = "The base type system library"
-docs_url = "https://developer.gnome.org/gobject/stable";
+docs_url = "https://docs.gtk.org/gobject/";
 
 [dependencies."GSSDP-1.6"]
 name = "GSSDP"
diff --git a/doc/urlmap.js b/doc/urlmap.js
index 4e19607..03182aa 100644
--- a/doc/urlmap.js
+++ b/doc/urlmap.js
@@ -1,4 +1,8 @@
 // A map between namespaces and base URLs for their online documentation
 baseURLs = [
+    [ 'GLib', 'https://docs.gtk.org/glib/' ],
+    [ 'GObject', 'https://docs.gtk.org/gobject/' ],
+    [ 'Gio', 'https://docs.gtk.org/gio/' ],
     [ 'GSSDP', 'https://gnome.pages.gitlab.gnome.org/gssdp/docs/' ],
+    [ 'libxml2', 'https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#']
 ]
diff --git a/libgupnp/gupnp-service-proxy.c b/libgupnp/gupnp-service-proxy.c
index 0287224..a01e2b8 100644
--- a/libgupnp/gupnp-service-proxy.c
+++ b/libgupnp/gupnp-service-proxy.c
@@ -622,8 +622,8 @@ gupnp_service_proxy_add_notify_full (GUPnPServiceProxy              *proxy,
  *
  * Get a notification for anything that happens on the peer.
  *
- * @value in @callback will be of type #G_TYPE_POINTER and contain the pre-parsed
- * #xmlDoc. Do NOT free or modify this document.
+ * @value in @callback will be of type G_TYPE_POINTER and contain the pre-parsed
+ * [type libxml2 Doc]. Do NOT free or modify this document.
  *
  * Return value: %TRUE on success.
  *
diff --git a/libgupnp/gupnp-xml-doc.c b/libgupnp/gupnp-xml-doc.c
index 4089988..4c96e9c 100644
--- a/libgupnp/gupnp-xml-doc.c
+++ b/libgupnp/gupnp-xml-doc.c
@@ -10,15 +10,6 @@
  *
  */
 
-/**
- * SECTION:gupnp-xml-doc
- * @short_description: GObject wrapper for xmlDoc.
- *
- * GObject wrapper for xmlDoc, so that we can use refcounting and weak
- * references.
- *
- * Since: 0.13.0
- */
 
 #include <config.h>
 #include <string.h>
@@ -28,9 +19,9 @@
 
 /**
  * GUPnPXMLDoc:
- * @doc: Pointer to the document.
- *
  * Reference-counting wrapper for libxml's #xmlDoc
+ *
+ * Since: 0.14.0
  */
 struct _GUPnPXMLDoc {
         GObject parent;


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