GNOME.org
 

[gssdp] Fix gtk-doc for stricter g-i scanner

commit d3ca04d87406219c722b2279b79108a96e20d5f1
Author: Jens Georg <mail jensge org>
Date:   Thu May 3 11:30:17 2012 +0200

    Fix gtk-doc for stricter g-i scanner

 libgssdp/gssdp-client.c           |   34 +++++++++++++++++-----------------
 libgssdp/gssdp-error.c            |    2 +-
 libgssdp/gssdp-resource-browser.c |   28 ++++++++++++++--------------
 libgssdp/gssdp-resource-browser.h |    2 +-
 libgssdp/gssdp-resource-group.c   |   32 ++++++++++++++++----------------
 5 files changed, 49 insertions(+), 49 deletions(-)
---
diff --git a/libgssdp/gssdp-client.c b/libgssdp/gssdp-client.c
index c2d2561..9f12435 100644
--- a/libgssdp/gssdp-client.c
+++ b/libgssdp/gssdp-client.c
@@ -399,7 +399,7 @@ gssdp_client_class_init (GSSDPClientClass *klass)
         g_type_class_add_private (klass, sizeof (GSSDPClientPrivate));
 
         /**
-         * GSSDPClient:server-id
+         * GSSDPClient:server-id:
          *
          * The SSDP server's identifier.
          **/
@@ -416,7 +416,7 @@ gssdp_client_class_init (GSSDPClientClass *klass)
                           G_PARAM_STATIC_BLURB));
 
         /**
-         * GSSDPClient:main-context
+         * GSSDPClient:main-context:
          *
          * The #GMainContext to use. Set to NULL to use the default.
          * Deprecated: 0.11.2: Use g_main_context_push_thread_default().
@@ -433,7 +433,7 @@ gssdp_client_class_init (GSSDPClientClass *klass)
                           G_PARAM_STATIC_BLURB));
 
         /**
-         * GSSDPClient:interface
+         * GSSDPClient:interface:
          *
          * The name of the network interface this client is associated with.
          * Set to NULL to autodetect.
@@ -453,7 +453,7 @@ gssdp_client_class_init (GSSDPClientClass *klass)
                           G_PARAM_STATIC_BLURB));
 
         /**
-         * GSSDPClient:network
+         * GSSDPClient:network:
          *
          * The network this client is currently connected to. You could set this
          * to anything you want to identify the network this client is
@@ -477,7 +477,7 @@ gssdp_client_class_init (GSSDPClientClass *klass)
                           G_PARAM_STATIC_BLURB));
 
         /**
-         * GSSDPClient:host-ip
+         * GSSDPClient:host-ip:
          *
          * The IP address of the assoicated network interface.
          **/
@@ -495,7 +495,7 @@ gssdp_client_class_init (GSSDPClientClass *klass)
                                       G_PARAM_STATIC_BLURB));
 
         /**
-         * GSSDPClient:active
+         * GSSDPClient:active:
          *
          * Whether this client is active or not (passive). When active
          * (default), the client sends messages on the network, otherwise
@@ -516,7 +516,7 @@ gssdp_client_class_init (GSSDPClientClass *klass)
                           G_PARAM_STATIC_BLURB));
 
         /**
-         * GSSDPClient::message-received
+         * GSSDPClient::message-received:
          *
          * Internal signal.
          *
@@ -538,7 +538,7 @@ gssdp_client_class_init (GSSDPClientClass *klass)
 }
 
 /**
- * gssdp_client_new
+ * gssdp_client_new:
  * @main_context: Deprecated: 0.11.2: Always set to NULL. If you want to
  *                specify a context use g_main_context_push_thread_default()
  * @iface: The name of the network interface, or %NULL for auto-detection.
@@ -564,7 +564,7 @@ gssdp_client_new (GMainContext *main_context,
 }
 
 /*
- * gssdp_client_get_main_context
+ * gssdp_client_get_main_context:
  * @client: A #GSSDPClient
  *
  * Returns: (transfer none): The #GMainContext @client is associated with, or NULL.
@@ -579,7 +579,7 @@ gssdp_client_get_main_context (GSSDPClient *client)
 }
 
 /**
- * gssdp_client_set_server_id
+ * gssdp_client_set_server_id:
  * @client: A #GSSDPClient
  * @server_id: The server ID
  *
@@ -603,7 +603,7 @@ gssdp_client_set_server_id (GSSDPClient *client,
 }
 
 /**
- * gssdp_client_get_server_id
+ * gssdp_client_get_server_id:
  * @client: A #GSSDPClient
  *
  * Return value: The server ID.
@@ -617,7 +617,7 @@ gssdp_client_get_server_id (GSSDPClient *client)
 }
 
 /**
- * gssdp_client_get_interface
+ * gssdp_client_get_interface:
  * @client: A #GSSDPClient
  *
  * Get the name of the network interface associated to @client.
@@ -633,7 +633,7 @@ gssdp_client_get_interface (GSSDPClient *client)
 }
 
 /**
- * gssdp_client_get_host_ip
+ * gssdp_client_get_host_ip:
  * @client: A #GSSDPClient
  *
  * Get the IP address we advertise ourselves as using.
@@ -649,7 +649,7 @@ gssdp_client_get_host_ip (GSSDPClient *client)
 }
 
 /**
- * gssdp_client_set_network
+ * gssdp_client_set_network:
  * @client: A #GSSDPClient
  * @network: The string identifying the network
  *
@@ -673,7 +673,7 @@ gssdp_client_set_network (GSSDPClient *client,
 }
 
 /**
- * gssdp_client_get_network
+ * gssdp_client_get_network:
  * @client: A #GSSDPClient
  *
  * Get the network this client is associated with.
@@ -689,7 +689,7 @@ gssdp_client_get_network (GSSDPClient *client)
 }
 
 /**
- * gssdp_client_get_active
+ * gssdp_client_get_active:
  * @client: A #GSSDPClient
  *
  * Return value: %TRUE if @client is active, %FALSE otherwise.
@@ -703,7 +703,7 @@ gssdp_client_get_active (GSSDPClient *client)
 }
 
 /**
- * _gssdp_client_send_message
+ * _gssdp_client_send_message:
  * @client: A #GSSDPClient
  * @dest_ip: The destination IP address, or NULL to broadcast
  * @dest_port: The destination port, or NULL for default
diff --git a/libgssdp/gssdp-error.c b/libgssdp/gssdp-error.c
index aa27ec6..31f1b16 100644
--- a/libgssdp/gssdp-error.c
+++ b/libgssdp/gssdp-error.c
@@ -22,7 +22,7 @@
 #include "gssdp-error.h"
 
 /**
- * gssdp_error_quark
+ * gssdp_error_quark:
  *
  * Returns: a #GQuark uniquely used by GSSDP's errors.
  **/
diff --git a/libgssdp/gssdp-resource-browser.c b/libgssdp/gssdp-resource-browser.c
index 9441d5b..73b47fa 100644
--- a/libgssdp/gssdp-resource-browser.c
+++ b/libgssdp/gssdp-resource-browser.c
@@ -259,7 +259,7 @@ gssdp_resource_browser_class_init (GSSDPResourceBrowserClass *klass)
         g_type_class_add_private (klass, sizeof (GSSDPResourceBrowserPrivate));
 
         /**
-         * GSSDPResourceBrowser:client
+         * GSSDPResourceBrowser:client:
          *
          * The #GSSDPClient to use.
          **/
@@ -276,7 +276,7 @@ gssdp_resource_browser_class_init (GSSDPResourceBrowserClass *klass)
                           G_PARAM_STATIC_BLURB));
 
         /**
-         * GSSDPResourceBrowser:target
+         * GSSDPResourceBrowser:target:
          *
          * The discovery target.
          **/
@@ -293,7 +293,7 @@ gssdp_resource_browser_class_init (GSSDPResourceBrowserClass *klass)
                           G_PARAM_STATIC_BLURB));
 
         /**
-         * GSSDPResourceBrowser:mx
+         * GSSDPResourceBrowser:mx:
          *
          * The maximum number of seconds in which to request other parties
          * to respond.
@@ -314,7 +314,7 @@ gssdp_resource_browser_class_init (GSSDPResourceBrowserClass *klass)
                           G_PARAM_STATIC_BLURB));
 
         /**
-         * GSSDPResourceBrowser:active
+         * GSSDPResourceBrowser:active:
          *
          * Whether this browser is active or not.
          **/
@@ -331,7 +331,7 @@ gssdp_resource_browser_class_init (GSSDPResourceBrowserClass *klass)
                           G_PARAM_STATIC_BLURB));
 
         /**
-         * GSSDPResourceBrowser::resource-available
+         * GSSDPResourceBrowser::resource-available:
          * @resource_browser: The #GSSDPResourceBrowser that received the
          * signal
          * @usn: The USN of the discovered resource
@@ -355,7 +355,7 @@ gssdp_resource_browser_class_init (GSSDPResourceBrowserClass *klass)
                               G_TYPE_POINTER);
 
         /**
-         * GSSDPResourceBrowser::resource-unavailable
+         * GSSDPResourceBrowser::resource-unavailable:
          * @resource_browser: The #GSSDPResourceBrowser that received the
          * signal
          * @usn: The USN of the resource
@@ -377,7 +377,7 @@ gssdp_resource_browser_class_init (GSSDPResourceBrowserClass *klass)
 }
 
 /**
- * gssdp_resource_browser_new
+ * gssdp_resource_browser_new:
  * @client: The #GSSDPClient to associate with
  *
  * Return value: A new #GSSDPResourceBrowser object.
@@ -415,7 +415,7 @@ gssdp_resource_browser_set_client (GSSDPResourceBrowser *resource_browser,
 }
 
 /**
- * gssdp_resource_browser_get_client
+ * gssdp_resource_browser_get_client:
  * @resource_browser: A #GSSDPResourceBrowser
  *
  * Returns: (transfer none): The #GSSDPClient @resource_browser is associated with.
@@ -430,7 +430,7 @@ gssdp_resource_browser_get_client (GSSDPResourceBrowser *resource_browser)
 }
 
 /**
- * gssdp_resource_browser_set_target
+ * gssdp_resource_browser_set_target:
  * @resource_browser: A #GSSDPResourceBrowser
  * @target: The browser target
  *
@@ -490,7 +490,7 @@ gssdp_resource_browser_set_target (GSSDPResourceBrowser *resource_browser,
 }
 
 /**
- * gssdp_resource_browser_get_target
+ * gssdp_resource_browser_get_target:
  * @resource_browser: A #GSSDPResourceBrowser
  *
  * Return value: The browser target.
@@ -505,7 +505,7 @@ gssdp_resource_browser_get_target (GSSDPResourceBrowser *resource_browser)
 }
 
 /**
- * gssdp_resource_browser_set_mx
+ * gssdp_resource_browser_set_mx:
  * @resource_browser: A #GSSDPResourceBrowser
  * @mx: The to be used MX value
  *
@@ -526,7 +526,7 @@ gssdp_resource_browser_set_mx (GSSDPResourceBrowser *resource_browser,
 }
 
 /**
- * gssdp_resource_browser_get_mx
+ * gssdp_resource_browser_get_mx:
  * @resource_browser: A #GSSDPResourceBrowser
  *
  * Return value: The used MX value.
@@ -540,7 +540,7 @@ gssdp_resource_browser_get_mx (GSSDPResourceBrowser *resource_browser)
 }
 
 /**
- * gssdp_resource_browser_set_active
+ * gssdp_resource_browser_set_active:
  * @resource_browser: A #GSSDPResourceBrowser
  * @active: TRUE to activate @resource_browser
  *
@@ -569,7 +569,7 @@ gssdp_resource_browser_set_active (GSSDPResourceBrowser *resource_browser,
 }
 
 /**
- * gssdp_resource_browser_get_active
+ * gssdp_resource_browser_get_active:
  * @resource_browser: A #GSSDPResourceBrowser
  *
  * Return value: TRUE if @resource_browser is active.
diff --git a/libgssdp/gssdp-resource-browser.h b/libgssdp/gssdp-resource-browser.h
index 1b9e670..5d2d1a9 100644
--- a/libgssdp/gssdp-resource-browser.h
+++ b/libgssdp/gssdp-resource-browser.h
@@ -79,7 +79,7 @@ struct _GSSDPResourceBrowserClass {
 };
 
 /**
- * GSSDP_ALL_RESOURCES
+ * GSSDP_ALL_RESOURCES:
  *
  * SSDP search target for finding all possible resources.
  **/
diff --git a/libgssdp/gssdp-resource-group.c b/libgssdp/gssdp-resource-group.c
index 8fd68f8..5b33356 100644
--- a/libgssdp/gssdp-resource-group.c
+++ b/libgssdp/gssdp-resource-group.c
@@ -291,7 +291,7 @@ gssdp_resource_group_class_init (GSSDPResourceGroupClass *klass)
         g_type_class_add_private (klass, sizeof (GSSDPResourceGroupPrivate));
 
         /**
-         * GSSDPResourceGroup:client
+         * GSSDPResourceGroup:client:
          *
          * The #GSSDPClient to use.
          **/
@@ -308,7 +308,7 @@ gssdp_resource_group_class_init (GSSDPResourceGroupClass *klass)
                           G_PARAM_STATIC_BLURB));
 
         /**
-         * GSSDPResourceGroup:max-age
+         * GSSDPResourceGroup:max-age:
          *
          * The number of seconds our advertisements are valid.
          **/
@@ -327,7 +327,7 @@ gssdp_resource_group_class_init (GSSDPResourceGroupClass *klass)
                           G_PARAM_STATIC_BLURB));
 
         /**
-         * GSSDPResourceGroup:available
+         * GSSDPResourceGroup:available:
          *
          * Whether this group of resources is available or not.
          **/
@@ -345,7 +345,7 @@ gssdp_resource_group_class_init (GSSDPResourceGroupClass *klass)
                           G_PARAM_STATIC_BLURB));
 
         /**
-         * GSSDPResourceGroup:message-delay
+         * GSSDPResourceGroup:message-delay:
          *
          * The minimum number of milliseconds between SSDP messages.
          * The default is 120 based on DLNA specification.
@@ -367,7 +367,7 @@ gssdp_resource_group_class_init (GSSDPResourceGroupClass *klass)
 }
 
 /**
- * gssdp_resource_group_new
+ * gssdp_resource_group_new:
  * @client: The #GSSDPClient to associate with
  *
  * Return value: A new #GSSDPResourceGroup object.
@@ -403,7 +403,7 @@ gssdp_resource_group_set_client (GSSDPResourceGroup *resource_group,
 }
 
 /**
- * gssdp_resource_group_get_client
+ * gssdp_resource_group_get_client:
  * @resource_group: A #GSSDPResourceGroup
  *
  * Returns: (transfer none): The #GSSDPClient @resource_group is associated with.
@@ -417,7 +417,7 @@ gssdp_resource_group_get_client (GSSDPResourceGroup *resource_group)
 }
 
 /**
- * gssdp_resource_group_set_max_age
+ * gssdp_resource_group_set_max_age:
  * @resource_group: A #GSSDPResourceGroup
  * @max_age: The number of seconds advertisements are valid
  *
@@ -438,7 +438,7 @@ gssdp_resource_group_set_max_age (GSSDPResourceGroup *resource_group,
 }
 
 /**
- * gssdp_resource_group_get_max_age
+ * gssdp_resource_group_get_max_age:
  * @resource_group: A #GSSDPResourceGroup
  *
  * Return value: The number of seconds advertisements are valid.
@@ -452,7 +452,7 @@ gssdp_resource_group_get_max_age (GSSDPResourceGroup *resource_group)
 }
 
 /**
- * gssdp_resource_group_set_message_delay
+ * gssdp_resource_group_set_message_delay:
  * @resource_group: A #GSSDPResourceGroup
  * @message_delay: The message delay in ms.
  *
@@ -473,7 +473,7 @@ gssdp_resource_group_set_message_delay (GSSDPResourceGroup *resource_group,
 }
 
 /**
- * gssdp_resource_group_get_message_delay
+ * gssdp_resource_group_get_message_delay:
  * @resource_group: A #GSSDPResourceGroup
  *
  * Return value: the minimum time between each SSDP message in ms.
@@ -511,7 +511,7 @@ send_announcement_set (GList *resources, GFunc message_function)
 }
 
 /**
- * gssdp_resource_group_set_available
+ * gssdp_resource_group_set_available:
  * @resource_group: A #GSSDPResourceGroup
  * @available: TRUE if @resource_group should be available (advertised)
  *
@@ -576,7 +576,7 @@ gssdp_resource_group_set_available (GSSDPResourceGroup *resource_group,
 }
 
 /**
- * gssdp_resource_group_get_available
+ * gssdp_resource_group_get_available:
  * @resource_group: A #GSSDPResourceGroup
  *
  * Return value: TRUE if @resource_group is available (advertised).
@@ -590,11 +590,11 @@ gssdp_resource_group_get_available (GSSDPResourceGroup *resource_group)
 }
 
 /**
- * gssdp_resource_group_add_resource
+ * gssdp_resource_group_add_resource:
  * @resource_group: An @GSSDPResourceGroup
  * @target: The resource's target
  * @usn: The resource's USN
- * @locations: A #GList of the resource's locations
+ * @locations: (element-type utf8): A #GList of the resource's locations
  *
  * Adds a resource with target @target, USN @usn, and locations @locations
  * to @resource_group.
@@ -655,7 +655,7 @@ gssdp_resource_group_add_resource (GSSDPResourceGroup *resource_group,
 }
 
 /**
- * gssdp_resource_group_add_resource_simple
+ * gssdp_resource_group_add_resource_simple:
  * @resource_group: An @GSSDPResourceGroup
  * @target: The resource's target
  * @usn: The resource's USN
@@ -684,7 +684,7 @@ gssdp_resource_group_add_resource_simple (GSSDPResourceGroup *resource_group,
 }
 
 /**
- * gssdp_resource_group_remove_resource
+ * gssdp_resource_group_remove_resource:
  * @resource_group: An @GSSDPResourceGroup
  * @resource_id: The ID of the resource to remove
  *
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]