[gupnp/wip/gi-docgen: 51/61] wip

[Jens Georg <jensgeorg src gnome org>]

commit 5d2ab7726b73d93abdb04bab4fe426f4f8363f83
Author: Jens Georg <mail jensge org>
Date:   Sat Aug 14 09:05:15 2021 +0200

    wip

 libgupnp/gupnp-context.c          | 35 ++++++++++++++++++-----------------
 libgupnp/gupnp-context.h          |  9 +++++++++
 libgupnp/gupnp-control-point.c    | 13 ++++++++-----
 libgupnp/gupnp-resource-factory.c | 17 +++++++++--------
 4 files changed, 44 insertions(+), 30 deletions(-)
---
diff --git a/libgupnp/gupnp-context.c b/libgupnp/gupnp-context.c
index 335cce8..906f396 100644
--- a/libgupnp/gupnp-context.c
+++ b/libgupnp/gupnp-context.c
@@ -11,14 +11,15 @@
  */
 
 /**
- * SECTION:gupnp-context
- * @short_description: Context object wrapping shared networking bits.
+ * GUPnPContext:
+ *
+ * Context object wrapping shared networking bits.
  *
  * #GUPnPContext wraps the networking bits that are used by the various
  * GUPnP classes. It automatically starts a web server on demand.
  *
  * For debugging, it is possible to see the messages being sent and received by
- * exporting <envar>GUPNP_DEBUG</envar>.
+ * setting the environment variable `GUPNP_DEBUG`.
  */
 
 #define G_LOG_DOMAIN "gupnp-context"
@@ -362,7 +363,7 @@ gupnp_context_class_init (GUPnPContextClass *klass)
         object_class->finalize     = gupnp_context_finalize;
 
         /**
-         * GUPnPContext:server:
+         * GUPnPContext:server:(attributes org.gtk.Property.get=gupnp_context_get_server)
          *
          * The #SoupServer HTTP server used by GUPnP.
          **/
@@ -379,7 +380,7 @@ gupnp_context_class_init (GUPnPContextClass *klass)
                                       G_PARAM_STATIC_BLURB));
 
         /**
-         * GUPnPContext:session:
+         * GUPnPContext:session:(attributes org.gtk.Property.get=gupnp_context_get_session)
          *
          * The #SoupSession object used by GUPnP.
          **/
@@ -396,7 +397,7 @@ gupnp_context_class_init (GUPnPContextClass *klass)
                                       G_PARAM_STATIC_BLURB));
 
         /**
-         * GUPnPContext:subscription-timeout:
+         * GUPnPContext:subscription-timeout:(attributes 
org.gtk.Property.get=gupnp_context_get_subscription_timeout 
org.gtk.Property.set=gupnp_context_set_subscription_timeout)
          *
          * The preferred subscription timeout: the number of seconds after
          * which subscriptions are renewed. Set to '0' if subscriptions 
@@ -417,7 +418,7 @@ gupnp_context_class_init (GUPnPContextClass *klass)
                                     G_PARAM_STATIC_NICK |
                                     G_PARAM_STATIC_BLURB));
         /**
-         * GUPnPContext:default-language:
+         * GUPnPContext:default-language:(attributes org.gtk.Property.get=gupnp_context_get_default_language 
org.gtk.Property.set=gupnp_context_set_default_language)
          *
          * The content of the Content-Language header id the client
          * sends Accept-Language and no language-specific pages to serve
@@ -439,7 +440,7 @@ gupnp_context_class_init (GUPnPContextClass *klass)
                                       G_PARAM_STATIC_BLURB));
 
         /**
-         * GUPnPContext:acl:
+         * GUPnPContext:acl:(attributes org.gtk.Property.get=gupnp_context_get_acl 
org.gtk.Property.set=gupnp_context_set_acl)
          *
          * An access control list.
          *
@@ -458,7 +459,7 @@ gupnp_context_class_init (GUPnPContextClass *klass)
 }
 
 /**
- * gupnp_context_get_session:
+ * gupnp_context_get_session:(attributes org.gtk.Method.get_property=session)
  * @context: A #GUPnPContext
  *
  * Get the #SoupSession object that GUPnP is using.
@@ -496,7 +497,7 @@ default_server_handler (G_GNUC_UNUSED SoupServer *server,
 }
 
 /**
- * gupnp_context_get_server:
+ * gupnp_context_get_server:(attributes org.gtk.Method.get_property=server)
  * @context: A #GUPnPContext
  *
  * Get the #SoupServer HTTP server that GUPnP is using.
@@ -614,7 +615,7 @@ gupnp_context_new (const char   *iface,
 }
 
 /**
- * gupnp_context_get_port:
+ * gupnp_context_get_port:(attributes org.gtk.Method.get_property=port)
  * @context: A #GUPnPContext
  *
  * Get the port that the SOAP server is running on.
@@ -636,7 +637,7 @@ gupnp_context_get_port (GUPnPContext *context)
 }
 
 /**
- * gupnp_context_set_subscription_timeout:
+ * gupnp_context_set_subscription_timeout:(attributes org.gtk.Method.set_property=subscription-timeout)
  * @context: A #GUPnPContext
  * @timeout: Event subscription timeout in seconds
  *
@@ -659,7 +660,7 @@ gupnp_context_set_subscription_timeout (GUPnPContext *context,
 }
 
 /**
- * gupnp_context_get_subscription_timeout:
+ * gupnp_context_get_subscription_timeout:(attributes org.gtk.Method.get_property=subscription-timeout)
  * @context: A #GUPnPContext
  *
  * Get the event subscription timeout (in seconds), or 0 meaning there is no
@@ -693,7 +694,7 @@ host_path_data_set_language (HostPathData *data, const char *language)
 }
 
 /**
- * gupnp_context_set_default_language:
+ * gupnp_context_set_default_language:(attributes org.gtk.Method.set_property=default-language)
  * @context: A #GUPnPContext
  * @language: A language tag as defined in RFC 2616 3.10
  *
@@ -733,7 +734,7 @@ gupnp_context_set_default_language (GUPnPContext *context,
 }
 
 /**
- * gupnp_context_get_default_language:
+ * gupnp_context_get_default_language:(attributes org.gtk.Method.get_property=default-language)
  * @context: A #GUPnPContext
  *
  * Get the default Content-Language header for this context.
@@ -1334,7 +1335,7 @@ gupnp_context_unhost_path (GUPnPContext *context,
 }
 
 /**
- * gupnp_context_get_acl:
+ * gupnp_context_get_acl:(attributes org.gtk.Method.get_property=acl)
  * @context: A #GUPnPContext
  *
  * Access the #GUPnPAcl associated with this client. If there isn't any,
@@ -1357,7 +1358,7 @@ gupnp_context_get_acl (GUPnPContext *context)
 }
 
 /**
- * gupnp_context_set_acl:
+ * gupnp_context_set_acl:(attributes org.gtk.Method.set_property=acl)
  * @context: A #GUPnPContext
  * @acl: (nullable): The new access control list or %NULL to remove the
  * current list.
diff --git a/libgupnp/gupnp-context.h b/libgupnp/gupnp-context.h
index d722ed7..79b3e30 100644
--- a/libgupnp/gupnp-context.h
+++ b/libgupnp/gupnp-context.h
@@ -26,7 +26,16 @@ struct _GUPnPContextClass {
         GSSDPClientClass parent_class;
 
         /* future padding */
+        /*<private>*/
+        /**
+         * _gupnp_reserved1:(skip):
+         *
+         * Padding
+         */
         void (* _gupnp_reserved1) (void);
+        /**
+         * _gupnp_reserved2:(skip):
+         */
         void (* _gupnp_reserved2) (void);
         void (* _gupnp_reserved3) (void);
         void (* _gupnp_reserved4) (void);
diff --git a/libgupnp/gupnp-control-point.c b/libgupnp/gupnp-control-point.c
index 97bdfa5..6b7ad6b 100644
--- a/libgupnp/gupnp-control-point.c
+++ b/libgupnp/gupnp-control-point.c
@@ -8,13 +8,16 @@
  */
 
 /**
- * SECTION:gupnp-control-point
- * @short_description: Class for resource discovery.
+ * GUPnPControlPoint:
+ *
+ * Class for resource discovery.
  *
  * #GUPnPControlPoint handles device and service discovery. After creating
- * a control point and activating it using gssdp_resource_browser_set_active(),
- * the ::device-proxy-available, ::service-proxy-available,
- * ::device-proxy-unavailable and ::service-proxy-unavailable signals will
+ * a control point and activating it using [method@GSSDP.ResourceBrowser.set_active],
+ * the [signal@GUPnP.ControlPoint::device-proxy-available],
+ * [signal@GUPnP.ControlPoint::service-proxy-available],
+ * [signal@GUPnP.ControlPoint::device-proxy-unavailable] and
+ * [signal@GUPnP.ControlPoint::service-proxy-unavailable] signals will
  * be emitted whenever the availability of a device or service matching
  * the specified discovery target changes.
  */
diff --git a/libgupnp/gupnp-resource-factory.c b/libgupnp/gupnp-resource-factory.c
index 9e441dc..5c158ee 100644
--- a/libgupnp/gupnp-resource-factory.c
+++ b/libgupnp/gupnp-resource-factory.c
@@ -10,16 +10,18 @@
  */
 
 /**
- * SECTION:gupnp-resource-factory
- * @short_description: Class for resource and resource proxy object creation.
+ * GUPnPResourceFactory:
+ * Associating custom Services, Devices, ServiceProxies and DeviceProxies with UPnP types.
  *
- * #GUPnPResourceFactory objects are used by #GUPnPControlPoint,
- * #GUPnPDeviceProxy and #GUPnPDevice to create resource proxy and resource
- * objects. Register UPnP type - #GType pairs to have resource or resource proxy
+ * #GUPnPResourceFactory objects are used by [class@GUPnP.ControlPoint],
+ * [class@GUPnP.DeviceProxy] and [class@GUPnP.Device] to create resource proxy and resource
+ * objects.
+ *
+ * Register UPnP type - [struct GLib Type] pairs to have resource or resource proxy
  * objects created with the specified #GType whenever an object for a resource
- * of the specified UPnP type is requested. The #GType<!-- -->s need
+ * of the specified UPnP type is requested. The #GType needs
  * to be derived from the relevant resource or resource proxy type (e.g.
- * a device proxy type needs to be derived from #GUPnPDeviceProxy).
+ * a device proxy type needs to be derived from [class@GUPnP.DeviceProxy]).
  */
 
 #include <config.h>
@@ -187,7 +189,6 @@ lookup_type_with_fallback (GHashTable *resource_types,
  * @location: The location of the device description file
  * @url_base: The URL base for this device, or %NULL if none
  *
- *
  * Create a #GUPnPDeviceProxy for the device with element @element, as
  * read from the device description file specified by @location.
  *