Misc doc changes
authorJens Georg <jensg@openismus.com>
Wed, 30 Oct 2013 13:32:58 +0000 (14:32 +0100)
committerJens Georg <jensg@openismus.com>
Wed, 30 Oct 2013 13:32:58 +0000 (14:32 +0100)
libgssdp/gssdp-client.c
libgssdp/gssdp-resource-browser.c
libgssdp/gssdp-resource-group.c

index cf0f0cb..1244e99 100644 (file)
@@ -631,7 +631,7 @@ gssdp_client_class_init (GSSDPClientClass *klass)
  * gssdp_client_new:
  * @main_context: (allow-none): 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.
+ * @iface: (allow-none): The name of the network interface, or %NULL for auto-detection.
  * @error: Location to store error, or NULL
  *
  * Return value: A new #GSSDPClient object.
@@ -680,7 +680,7 @@ gssdp_client_new_with_port (const char *iface,
  * gssdp_client_get_main_context: (skip)
  * @client: A #GSSDPClient
  *
- * Returns: (transfer none): The #GMainContext @client is associated with, or NULL.
+ * Returns: (transfer none): The #GMainContext @client is associated with, or %NULL.
  * Deprecated: 0.11.2: Returns g_main_context_get_thread_default()
  **/
 GMainContext *
@@ -818,8 +818,8 @@ gssdp_client_get_active (GSSDPClient *client)
 /**
  * _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
+ * @dest_ip: (allow-none): The destination IP address, or %NULL to broadcast
+ * @dest_port: (allow-none): The destination port, or %NULL for default
  * @message: The message to send
  *
  * Sends @message to @dest_ip.
index 00e9a17..7db5d1f 100644 (file)
@@ -563,7 +563,7 @@ gssdp_resource_browser_get_mx (GSSDPResourceBrowser *resource_browser)
 /**
  * gssdp_resource_browser_set_active:
  * @resource_browser: A #GSSDPResourceBrowser
- * @active: TRUE to activate @resource_browser
+ * @active: %TRUE to activate @resource_browser
  *
  * (De)activates @resource_browser.
  **/
@@ -593,7 +593,7 @@ gssdp_resource_browser_set_active (GSSDPResourceBrowser *resource_browser,
  * gssdp_resource_browser_get_active:
  * @resource_browser: A #GSSDPResourceBrowser
  *
- * Return value: TRUE if @resource_browser is active.
+ * Return value: %TRUE if @resource_browser is active.
  **/
 gboolean
 gssdp_resource_browser_get_active (GSSDPResourceBrowser *resource_browser)
index 08f2f7e..dac4c78 100644 (file)
@@ -515,7 +515,7 @@ send_announcement_set (GList *resources, GFunc message_function)
 /**
  * gssdp_resource_group_set_available:
  * @resource_group: A #GSSDPResourceGroup
- * @available: TRUE if @resource_group should be available (advertised)
+ * @available: %TRUE if @resource_group should be available (advertised)
  *
  * Sets @resource_group<!-- -->s availability to @available. Changing
  * @resource_group<!-- -->s availability causes it to announce its new state
@@ -593,7 +593,7 @@ gssdp_resource_group_get_available (GSSDPResourceGroup *resource_group)
 
 /**
  * gssdp_resource_group_add_resource:
- * @resource_group: An @GSSDPResourceGroup
+ * @resource_group: A #GSSDPResourceGroup
  * @target: The resource's target
  * @usn: The resource's USN
  * @locations: (element-type utf8): A #GList of the resource's locations
@@ -658,7 +658,7 @@ gssdp_resource_group_add_resource (GSSDPResourceGroup *resource_group,
 
 /**
  * gssdp_resource_group_add_resource_simple:
- * @resource_group: An @GSSDPResourceGroup
+ * @resource_group: A #GSSDPResourceGroup
  * @target: The resource's target
  * @usn: The resource's USN
  * @location: The resource's location
@@ -687,7 +687,7 @@ gssdp_resource_group_add_resource_simple (GSSDPResourceGroup *resource_group,
 
 /**
  * gssdp_resource_group_remove_resource:
- * @resource_group: An @GSSDPResourceGroup
+ * @resource_group: A #GSSDPResourceGroup
  * @resource_id: The ID of the resource to remove
  *
  * Removes the resource with ID @resource_id from @resource_group.