Commit d2e14343 authored by Zach Goldberg's avatar Zach Goldberg Committed by Zeeshan Ali (Khattak)
Browse files

Add gobject-introspection annotations

parent 8fe3d660
......@@ -1057,13 +1057,14 @@ gupnp_control_point_get_context (GUPnPControlPoint *control_point)
}
/**
* gupnp_control_point_list_device_proxies
* gupnp_control_point_list_device_proxies:
* @control_point: A #GUPnPControlPoint
*
* Get the #GList of discovered #GUPnPDeviceProxy objects. Do not free the list
* nor its elements.
*
* Return value: a #GList of #GUPnPDeviceProxy objects.
* Return value: (element-type GUPnP.DeviceProxy) (transfer none): a #GList of
* #GUPnPDeviceProxy objects.
**/
const GList *
gupnp_control_point_list_device_proxies (GUPnPControlPoint *control_point)
......@@ -1074,13 +1075,14 @@ gupnp_control_point_list_device_proxies (GUPnPControlPoint *control_point)
}
/**
* gupnp_control_point_list_service_proxies
* gupnp_control_point_list_service_proxies:
* @control_point: A #GUPnPControlPoint
*
* Get the #GList of discovered #GUPnPServiceProxy objects. Do not free the list
* nor its elements.
* Get the #GList of discovered #GUPnPServiceProxy objects. Do not free the
* list nor its elements.
*
* Return value: a #GList of #GUPnPServiceProxy objects.
* Return value: (element-type: GUPnP.ServiceProxy) (transfer none): a #GList
* of #GUPnPServiceProxy objects.
**/
const GList *
gupnp_control_point_list_service_proxies (GUPnPControlPoint *control_point)
......
......@@ -691,19 +691,24 @@ icon_free (Icon *icon)
}
/**
* gupnp_device_info_get_icon_url
* gupnp_device_info_get_icon_url:
* @info: A #GUPnPDeviceInfo
* @requested_mime_type: The requested file format, or %NULL for any
* @requested_mime_type: (allow-none) (transfer none): The requested file
* format, or %NULL for any
* @requested_depth: The requested color depth, or -1 for any
* @requested_width: The requested width, or -1 for any
* @requested_height: The requested height, or -1 for any
* @prefer_bigger: %TRUE if a bigger, rather than a smaller icon should be
* returned if no exact match could be found
* @mime_type: The location where to store the the format of the returned icon,
* or %NULL. The returned string should be freed after use
* @depth: The location where to store the depth of the returned icon, or %NULL
* @width: The location where to store the width of the returned icon, or %NULL
* @height: The location where to store the height of the returned icon, or %NULL
* @mime_type: (out) (allow-none): The location where to store the the format
* of the returned icon, or %NULL. The returned string should be freed after
* use
* @depth: (out) (allow-none) : The location where to store the depth of the
* returned icon, or %NULL
* @width: (out) (allow-none) : The location where to store the width of the
* returned icon, or %NULL
* @height: (out) (allow-none) : The location where to store the height of the
* returned icon, or %NULL
*
* Get a URL pointing to the icon most closely matching the
* given criteria, or %NULL. If @requested_mime_type is set, only icons with
......@@ -713,7 +718,7 @@ icon_free (Icon *icon)
* returned, unless @prefer_bigger is set, in which case the next biggest icon
* will be returned. The returned strings should be freed.
*
* Return value: a string, or %NULL. g_free() after use.
* Return value: (transfer full): a string, or %NULL. g_free() after use.
**/
char *
gupnp_device_info_get_icon_url (GUPnPDeviceInfo *info,
......@@ -928,13 +933,12 @@ resource_type_match (const char *query,
* gupnp_device_info_list_dlna_capabilities
* @info: A #GUPnPDeviceInfo
*
* Get a #GList of strings that represent the device capabilities as
* announced in the device description file using the
* <dlna:X_DLNACAP> element.
* Get a #GList of strings that represent the device capabilities as announced
* in the device description file using the <dlna:X_DLNACAP> element.
*
* Return value: a #GList of newly allocated strings or %NULL if
* the device description doesn't contain the
* <dlna:X_DLNACAP> element.
* Return value: (element-type utf8): a #GList of newly allocated strings or
* %NULL if the device description doesn't contain the <dlna:X_DLNACAP>
* element.
**/
GList *
gupnp_device_info_list_dlna_capabilities (GUPnPDeviceInfo *info)
......@@ -984,8 +988,8 @@ gupnp_device_info_list_dlna_capabilities (GUPnPDeviceInfo *info)
* @info: A #GUPnPDeviceInfo
* @element: Name of the description element to retrieve
*
* This function provides generic access to the contents of arbitrary
* elements in the device description file.
* This function provides generic access to the contents of arbitrary elements
* in the device description file.
*
* Return value: a newly allocated string or %NULL if the device
* description doesn't contain the given @element
......@@ -1002,7 +1006,7 @@ gupnp_device_info_get_description_value (GUPnPDeviceInfo *info,
}
/**
* gupnp_device_info_list_devices
* gupnp_device_info_list_devices:
* @info: A #GUPnPDeviceInfo
*
* Get a #GList of new objects implementing #GUPnPDeviceInfo
......@@ -1014,7 +1018,8 @@ gupnp_device_info_get_description_value (GUPnPDeviceInfo *info,
* must cache any used devices if it wishes to keep them around and re-use
* them.
*
* Return value: a #GList of new #GUPnPDeviceInfo objects.
* Return value: (element-type GUPnP.DeviceInfo) (transfer full): a #GList of
* new #GUPnPDeviceInfo objects.
**/
GList *
gupnp_device_info_list_devices (GUPnPDeviceInfo *info)
......@@ -1050,14 +1055,14 @@ gupnp_device_info_list_devices (GUPnPDeviceInfo *info)
}
/**
* gupnp_device_info_list_device_types
* gupnp_device_info_list_device_types:
* @info: A #GUPnPDeviceInfo
*
* Get a #GList of strings representing the types of the devices
* directly contained in @info.
*
* Return value: A #GList of strings. The elements should be g_free()'d and the
* list should be g_list_free()'d.
* Return value: (element-type utf8) (transfer full): A #GList of strings. The
* elements should be g_free()'d and the list should be g_list_free()'d.
**/
GList *
gupnp_device_info_list_device_types (GUPnPDeviceInfo *info)
......@@ -1100,10 +1105,9 @@ gupnp_device_info_list_device_types (GUPnPDeviceInfo *info)
* a new object implementing #GUPnPDeviceInfo, or %NULL if no such device
* was found. The returned object should be unreffed when done.
*
* Note that devices are not cached internally, so that every time you
* call this function a new object is created. The application
* must cache any used devices if it wishes to keep them around and re-use
* them.
* Note that devices are not cached internally, so that every time you call
* this function a new object is created. The application must cache any used
* devices if it wishes to keep them around and re-use them.
*
* Return value: A new #GUPnPDeviceInfo.
**/
......@@ -1156,22 +1160,21 @@ gupnp_device_info_get_device (GUPnPDeviceInfo *info,
return device;
}
/**
* gupnp_device_info_list_services
* gupnp_device_info_list_services:
* @info: A #GUPnPDeviceInfo
*
* Get a #GList of new objects implementing #GUPnPServiceInfo
* representing the services directly contained in @info. The returned list
* should be g_list_free()'d and the elements should be g_object_unref()'d.
* Get a #GList of new objects implementing #GUPnPServiceInfo representing the
* services directly contained in @info. The returned list should be
* g_list_free()'d and the elements should be g_object_unref()'d.
*
* Note that services are not cached internally, so that every time you
* call this function new objects are created. The application
* must cache any used services if it wishes to keep them around and re-use
* them.
* Note that services are not cached internally, so that every time you call
* function new objects are created. The application must cache any used
* services if it wishes to keep them around and re-use them.
*
* Return value: A #GList of new #GUPnPServiceInfo objects.
**/
* Return value: (element-type GUPnP.ServiceInfo) (transfer full) : A #GList of
* new #GUPnPServiceInfo objects.
*/
GList *
gupnp_device_info_list_services (GUPnPDeviceInfo *info)
{
......@@ -1206,14 +1209,14 @@ gupnp_device_info_list_services (GUPnPDeviceInfo *info)
}
/**
* gupnp_device_info_list_service_types
* gupnp_device_info_list_service_types:
* @info: A #GUPnPDeviceInfo
*
* Get a #GList of strings representing the types of the services
* directly contained in @info.
*
* Return value: A #GList of strings. The elements should be g_free()'d and the
* list should be g_list_free()'d.
* Return value: (element-type utf8) (transfer full): A #GList of strings. The
* elements should be g_free()'d and the list should be g_list_free()'d.
**/
GList *
gupnp_device_info_list_service_types (GUPnPDeviceInfo *info)
......@@ -1252,14 +1255,13 @@ gupnp_device_info_list_service_types (GUPnPDeviceInfo *info)
* @info: A #GUPnPDeviceInfo
* @type: The type of the service to be retrieved.
*
* Get the service with type @type directly contained in @info as
* a new object implementing #GUPnPServiceInfo, or %NULL if no such device
* was found. The returned object should be unreffed when done.
* Get the service with type @type directly contained in @info as a new object
* implementing #GUPnPServiceInfo, or %NULL if no such device was found. The
* returned object should be unreffed when done.
*
* Note that services are not cached internally, so that every time you
* call this function a new object is created. The application
* must cache any used services if it wishes to keep them around and re-use
* them.
* Note that services are not cached internally, so that every time you call
* this function a new object is created. The application must cache any used
* services if it wishes to keep them around and re-use them.
*
* Return value: A #GUPnPServiceInfo.
**/
......
......@@ -547,8 +547,8 @@ gupnp_service_info_get_event_subscription_url (GUPnPServiceInfo *info)
* Warning: You should use gupnp_service_info_get_introspection_async()
* instead, this function re-enter the GMainloop before returning.
*
* Return value: A new #GUPnPServiceIntrospection for this service or %NULL.
* Unref after use.
* Return value: (transfer full): A new #GUPnPServiceIntrospection for this
* service or %NULL. Unref after use.
**/
GUPnPServiceIntrospection *
gupnp_service_info_get_introspection (GUPnPServiceInfo *info,
......
......@@ -755,13 +755,13 @@ gupnp_service_introspection_new (xmlDoc *scpd)
}
/**
* gupnp_service_introspection_list_action_names
* gupnp_service_introspection_list_action_names:
* @introspection: A #GUPnPServiceIntrospection
*
* Returns a GList of names of all the actions in this service.
*
* Return value: A GList of names of all the actions or %NULL. Do not modify
* or free it or its contents.
* Return value: (transfer none) (element-type utf8) : A GList of names of all
* the actions or %NULL. Do not modify or free it or its contents.
**/
const GList *
gupnp_service_introspection_list_action_names
......@@ -780,15 +780,15 @@ gupnp_service_introspection_list_action_names
}
/**
* gupnp_service_introspection_list_actions
* gupnp_service_introspection_list_actions:
* @introspection: A #GUPnPServiceIntrospection
*
* Returns a #GList of all the actions (of type #GUPnPServiceActionInfo) in
* this service.
*
* Return value: A #GList of all the actions or %NULL. Do not modify or free it
* or its contents.
*
* Return value: (element-type GUPnP.ServiceActionInfo*) (transfer none): A
* #GList of all the actions or %NULL. Do not modify or free it or its
* contents.
**/
const GList *
gupnp_service_introspection_list_actions
......@@ -798,14 +798,15 @@ gupnp_service_introspection_list_actions
}
/**
* gupnp_service_introspection_list_state_variables
* gupnp_service_introspection_list_state_variables:
* @introspection: A #GUPnPServiceIntrospection
*
* Returns a GList of all the state variables (of type
* #GUPnPServiceStateVariableInfo) in this service.
*
* Return value: A #GList of all the state variables or %NULL. Do not modify or
* free it or its contents.
* Return value: (element-type GUPnP.ServiceStateVariableInfo) (transfer none):
* A #GList of all the state variables or %NULL. Do not modify or free it or
* its contents.
*
**/
const GList *
......@@ -816,13 +817,13 @@ gupnp_service_introspection_list_state_variables
}
/**
* gupnp_service_introspection_list_state_variable_names
* gupnp_service_introspection_list_state_variable_names:
* @introspection: A #GUPnPServiceIntrospection
*
* Returns a #GList of names of all the state variables in this service.
*
* Return value: A #GList of names of all the state variables or %NULL. Do not
* modify or free it or its contents.
* Return value: (element-type utf8) (transfer none): A #GList of names of all
* the state variables or %NULL. Do not modify or free it or its contents.
**/
const GList *
gupnp_service_introspection_list_state_variable_names
......@@ -884,13 +885,14 @@ action_search_func (GUPnPServiceActionInfo *action,
}
/**
* gupnp_service_introspection_get_action
* gupnp_service_introspection_get_action:
* @introspection: A #GUPnPServiceIntrospection
* @action_name: The name of the action to retreive
*
* Returns the action by the name @action_name in this service.
*
* Return value: the action or %NULL. Do not modify or free it.
* Return value: (transfer none): the action or %NULL. Do not modify or free
* it.
**/
const GUPnPServiceActionInfo *
gupnp_service_introspection_get_action
......
......@@ -464,13 +464,14 @@ gupnp_service_proxy_send_action_valist (GUPnPServiceProxy *proxy,
}
/**
* gupnp_service_proxy_send_action_hash
* gupnp_service_proxy_send_action_hash:
* @proxy: A #GUPnPServiceProxy
* @action: An action
* @error: The location where to store any error, or %NULL
* @in_hash: A #GHashTable of in parameter name and #GValue pairs
* @out_hash: A #GHashTable of out parameter name and initialized
* #GValue pairs
* @in_hash: (element-type utf8 GValue) (transfer none): A #GHashTable of in
* parameter name and #GValue pairs
* @out_hash: (inout) (element-type utf8 GValue) (transfer full): A #GHashTable
* of out parameter name and initialized #GValue pairs
*
* See gupnp_service_proxy_send_action(); this version takes a pair of
* #GHashTable<!-- -->s for runtime determined parameter lists.
......@@ -537,8 +538,8 @@ gupnp_service_proxy_send_action_hash (GUPnPServiceProxy *proxy,
* gupnp_service_proxy_end_action() to check for errors, to retrieve return
* values, and to free the #GUPnPServiceProxyAction.
*
* Return value: A #GUPnPServiceProxyAction handle. This will
* be freed when calling gupnp_service_proxy_cancel_action() or
* Return value: A #GUPnPServiceProxyAction handle. This will be freed when
* gupnp_service_proxy_cancel_action() or
* gupnp_service_proxy_end_action_valist().
**/
GUPnPServiceProxyAction *
......@@ -835,7 +836,7 @@ gupnp_service_proxy_begin_action_valist
* See gupnp_service_proxy_begin_action(); this version takes a #GHashTable
* for runtime generated parameter lists.
*
* Return value: A #GUPnPServiceProxyAction handle. This will
* Return value: (transfer none): A #GUPnPServiceProxyAction handle. This will
* be freed when calling gupnp_service_proxy_cancel_action() or
* gupnp_service_proxy_end_action_hash().
**/
......@@ -1139,14 +1140,15 @@ gupnp_service_proxy_end_action_valist (GUPnPServiceProxy *proxy,
}
/**
* gupnp_service_proxy_end_action_hash
* gupnp_service_proxy_end_action_hash:
* @proxy: A #GUPnPServiceProxy
* @action: A #GUPnPServiceProxyAction handle
* @error: The location where to store any error, or %NULL
* @hash: A #GHashTable of out parameter name and initialised #GValue pairs
* @hash: (element-type utf8 GValue) (inout) (transfer none): A #GHashTable of
* out parameter name and initialised #GValue pairs
*
* See gupnp_service_proxy_end_action(); this version takes a #GHashTable
* for runtime generated parameter lists.
* See gupnp_service_proxy_end_action(); this version takes a #GHashTable for
* runtime generated parameter lists.
*
* Return value: %TRUE on success.
**/
......
......@@ -276,13 +276,14 @@ gupnp_service_action_get_name (GUPnPServiceAction *action)
}
/**
* gupnp_service_action_get_locales
* gupnp_service_action_get_locales:
* @action: A #GUPnPServiceAction
*
* Get an ordered (preferred first) #GList of locales preferred by
* the client. Free list and elements after use.
*
* Return value: A #GList of #char* locale names.
* Return value: (element-type utf8) (transfer full): A #GList of #char*
* locale names.
**/
GList *
gupnp_service_action_get_locales (GUPnPServiceAction *action)
......@@ -596,7 +597,8 @@ gupnp_service_action_return_error (GUPnPServiceAction *action,
* Get the #SoupMessage associated with @action. Mainly intended for
* applications to be able to read HTTP headers received from clients.
*
* Return value: #SoupMessage associated with @action. Unref after using it.
* Return value: (transfer full): #SoupMessage associated with @action. Unref
* after using it.
**/
SoupMessage *
gupnp_service_action_get_message (GUPnPServiceAction *action)
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment