[gupnp/wip/gi-docgen: 60/61] wip
- From: Jens Georg <jensgeorg src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gupnp/wip/gi-docgen: 60/61] wip
- Date: Mon, 3 Jan 2022 10:07:06 +0000 (UTC)
commit 7a06aaa9f5ed9f197d8713e6b3eaf14ae7ebba3b
Author: Jens Georg <mail jensge org>
Date: Mon Jan 3 09:32:02 2022 +0100
wip
libgupnp/gupnp-acl.c | 2 +-
libgupnp/gupnp-device-info.c | 6 +++--
libgupnp/gupnp-resource-factory.c | 2 +-
libgupnp/gupnp-service-info.c | 4 ++--
libgupnp/gupnp-service-info.h | 7 +++---
libgupnp/gupnp-service-introspection.c | 43 +++++++++++++++++-----------------
libgupnp/gupnp-service-introspection.h | 2 +-
subprojects/gi-docgen.wrap | 2 +-
8 files changed, 35 insertions(+), 33 deletions(-)
---
diff --git a/libgupnp/gupnp-acl.c b/libgupnp/gupnp-acl.c
index 25b6780..072045e 100644
--- a/libgupnp/gupnp-acl.c
+++ b/libgupnp/gupnp-acl.c
@@ -121,7 +121,7 @@ gupnp_acl_is_allowed_async (GUPnPAcl *self,
/**
* gupnp_acl_is_allowed_finish:
* @self: An instance of #GUPnPAcl
- * @res: [class@Gio.AsyncResult] obtained from the callback passed to [method GUPnP Acl.is_allowed_async]
+ * @res: [iface@Gio.AsyncResult] obtained from the callback passed to [method GUPnP Acl.is_allowed_async]
* @error: (inout)(optional)(nullable): A return location for a #GError describing the failure
* @returns %TRUE if the authentication was successful, %FALSE otherwise and on
* error. Check @error for details.
diff --git a/libgupnp/gupnp-device-info.c b/libgupnp/gupnp-device-info.c
index 617806b..09e17e3 100644
--- a/libgupnp/gupnp-device-info.c
+++ b/libgupnp/gupnp-device-info.c
@@ -35,9 +35,11 @@ typedef struct _GUPnPDeviceInfoPrivate GUPnPDeviceInfoPrivate;
/**
* GUPnPDeviceInfo:
- * Base abstract class for querying device information.
*
- * This class aggregates the information that is shared between remote and local devices
+ * Device information shared by local and remote devices
+ *
+ * This class aggregates the information that is shared between remote and local
+ * devices.
*/
G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (GUPnPDeviceInfo,
diff --git a/libgupnp/gupnp-resource-factory.c b/libgupnp/gupnp-resource-factory.c
index 644fa02..b651f91 100644
--- a/libgupnp/gupnp-resource-factory.c
+++ b/libgupnp/gupnp-resource-factory.c
@@ -18,7 +18,7 @@
* [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
+ * Register UPnP type - [alias 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 needs
* to be derived from the relevant resource or resource proxy type (e.g.
diff --git a/libgupnp/gupnp-service-info.c b/libgupnp/gupnp-service-info.c
index f2d82f2..39a0324 100644
--- a/libgupnp/gupnp-service-info.c
+++ b/libgupnp/gupnp-service-info.c
@@ -47,7 +47,7 @@ typedef struct _GUPnPServiceInfoPrivate GUPnPServiceInfoPrivate;
/**
* GUPnPServiceInfo:
*
- * Base abstract class for querying service information.
+ * Service information shared by local and remote services.
*
* A class that contains the common parts between local and remote services.
*/
@@ -707,7 +707,7 @@ gupnp_service_info_get_introspection_async
* gupnp_service_info_get_introspection_async_full:
* @info: A #GUPnPServiceInfo
* @callback: (scope async) : callback to be called when introspection object is ready.
- * @cancellable: (optional): GCancellable that can be used to cancel the call.
+ * @cancellable: (nullable): GCancellable that can be used to cancel the call.
* @user_data: user_data to be passed to the callback.
*
* Note that introspection object is created from the information in service
diff --git a/libgupnp/gupnp-service-info.h b/libgupnp/gupnp-service-info.h
index 2c561c0..0f346d1 100644
--- a/libgupnp/gupnp-service-info.h
+++ b/libgupnp/gupnp-service-info.h
@@ -16,8 +16,7 @@
G_BEGIN_DECLS
-#define GUPNP_TYPE_SERVICE_INFO \
- (gupnp_service_info_get_type ())
+#define GUPNP_TYPE_SERVICE_INFO (gupnp_service_info_get_type ())
G_DECLARE_DERIVABLE_TYPE (GUPnPServiceInfo,
gupnp_service_info,
@@ -38,8 +37,8 @@ struct _GUPnPServiceInfoClass {
/**
* GUPnPServiceIntrospectionCallback:
* @info: The #GUPnPServiceInfo introspection was requested for
- * @introspection: (nullable): The new #GUPnPServiceIntrospection object, or NULL
- * @error: (nullable): The #GError that occurred, or NULL
+ * @introspection: (nullable): The new #GUPnPServiceIntrospection object
+ * @error: (nullable): The #GError that occurred
* @user_data: User data
*
* Callback notifying that @introspection for @info has been obtained.
diff --git a/libgupnp/gupnp-service-introspection.c b/libgupnp/gupnp-service-introspection.c
index 68f09d7..3eb471c 100644
--- a/libgupnp/gupnp-service-introspection.c
+++ b/libgupnp/gupnp-service-introspection.c
@@ -9,27 +9,6 @@
*
*/
-/**
- * SECTION:gupnp-service-introspection
- * @short_description: Service introspection class.
- *
- * The #GUPnPServiceIntrospection class provides methods for service
- * introspection based on information contained in its service description
- * document (SCPD). There is no constructor provided for this class, please use
- * #gupnp_service_info_get_introspection or
- * #gupnp_service_info_get_introspection_async to create an
- * #GUPnPServiceIntrospection object for a specific service.
- *
- * Note that all the introspection information is retreived from the service
- * description document (SCPD) provided by the service and hence can not be
- * guaranteed to be complete. A UPnP service is required to provide a SCPD but
- * unfortunately, many services either do not provide this document or the
- * document does not provide any or all of the introspection information.
- *
- * This class exposes internals of the UPnP protocol and should not need
- * to be used for regular device or control point development.
- *
- **/
#include <config.h>
#include <libsoup/soup.h>
@@ -67,6 +46,28 @@ static GInitableIface *initable_parent_iface = NULL;
static void
gupnp_service_introspection_initable_iface_init (gpointer g_iface, gpointer iface_data);
+
+/**
+ * GUPnPServiceIntrospection:
+ *
+ * Introspection of local and remote services..
+ *
+ * The #GUPnPServiceIntrospection class provides methods for service
+ * introspection based on information contained in its service description
+ * document (SCPD). There is no constructor provided for this class, please use
+ * [method@GUPnP.ServiceInfo.introspect_async] to create a
+ * #GUPnPServiceIntrospection object for a specific service.
+ *
+ * Note that all the introspection information is retrieved from the service
+ * description document (SCPD) provided by the service and hence can not be
+ * guaranteed to be complete. A UPnP service is required to provide a SCPD but
+ * unfortunately, many services either do not provide this document or the
+ * document does not provide any or all of the introspection information.
+ *
+ * This class exposes internals of the UPnP protocol and should not need
+ * to be used for regular device or control point development.
+ *
+ **/
G_DEFINE_TYPE_EXTENDED (
GUPnPServiceIntrospection,
gupnp_service_introspection,
diff --git a/libgupnp/gupnp-service-introspection.h b/libgupnp/gupnp-service-introspection.h
index fecfc8e..9036976 100644
--- a/libgupnp/gupnp-service-introspection.h
+++ b/libgupnp/gupnp-service-introspection.h
@@ -63,7 +63,7 @@ gupnp_service_action_arg_info_get_type (void);
/**
* GUPnPServiceActionInfo:
* @name: The name of the action argument.
- * @arguments: (type GList) (element-type GUPnP.ServiceActionArgInfo):A GList of all the arguments
+ * @arguments:(element-type GUPnP.ServiceActionArgInfo):A GList of all the arguments
* (of type #GUPnPServiceActionArgInfo) of this action.
*
* This structure contains information about a service action.
diff --git a/subprojects/gi-docgen.wrap b/subprojects/gi-docgen.wrap
index c29b801..86ac2a8 100644
--- a/subprojects/gi-docgen.wrap
+++ b/subprojects/gi-docgen.wrap
@@ -1,2 +1,2 @@
[wrap-redirect]
-filename = gssdp-1.2/subprojects/gi-docgen.wrap
+filename = gssdp-1.6/subprojects/gi-docgen.wrap
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]