Commit 46027f35 authored by Jens Georg's avatar Jens Georg

all: Documentation fixes

parent f434d30c
......@@ -13,6 +13,7 @@ gupnp_service_get_type
gupnp_service_info_get_type
gupnp_service_introspection_get_type
gupnp_service_proxy_get_type
gupnp_service_proxy_action_get_type
gupnp_bin_base64_get_type
gupnp_bin_hex_get_type
gupnp_date_get_type
......
......@@ -9,6 +9,7 @@ gnome.gtkdoc('gupnp',
src_dir : [join_paths(meson.source_root(), 'libgupnp'),
join_paths(meson.build_root(), 'libgupnp')],
dependencies : libgupnp,
scan_args : ['--ignore-decorators', 'G_DEPRECATED|G_GNUC_DEPRECATED,G_DEPRECATED_FOR'],
ignore_headers : [
'gena-protocol.h',
'xml-util.h',
......
......@@ -1389,6 +1389,9 @@ gupnp_context_unhost_path (GUPnPContext *context,
* gupnp_context_get_acl:
* @context: A #GUPnPContext
*
* Access the #GUPnPAcl associated with this client. If there isn't any,
* retturns %NULL. The returned ACL must not be freed.
*
* Returns:(transfer none): The access control list associated with this context or %NULL
* if no acl is set.
*
......@@ -1411,6 +1414,9 @@ gupnp_context_get_acl (GUPnPContext *context)
* @acl: (allow-none): The new access control list or %NULL to remove the
* current list.
*
* Attach or remove the assoicated access control list to this context. If
* @acl is %NULL, the current access control list will be removed.
*
* Since: 0.20.11
**/
void
......@@ -1611,6 +1617,9 @@ gupnp_context_remove_server_handler (GUPnPContext *context, const char *path)
* @context: a #GUPnPContext
* @uri: an uri to rewrite if necessary
*
* Utility function to re-write an uri to the IPv6 link-local form which has
* the zone index appended to the IP address.
*
* Returns: A re-written version of the @uri if the context is on a link-local
* IPv6 address, a copy of the @uri otherwise.
*
......
......@@ -454,6 +454,20 @@ gupnp_service_proxy_action_get_result_hash (GUPnPServiceProxyAction *action,
}
/**
* gupnp_service_proxy_action_get_result:
* @action: A #GUPnPServiceProxyAction handle
* @error: (allow-none): The location where to store any error, or %NULL
* @...: tuples of out parameter name, out parameter type, and out parameter
* value location, terminated with %NULL. The out parameter values should be
* freed after use
*
* Retrieves the result of @action. The out parameters in @Varargs will be
* filled in, and if an error occurred, @error will be set. In case of
* an UPnP error the error code will be the same in @error.
*
* Return value: %TRUE on success.
**/
gboolean
gupnp_service_proxy_action_get_result (GUPnPServiceProxyAction *action,
GError **error,
......@@ -471,6 +485,18 @@ gupnp_service_proxy_action_get_result (GUPnPServiceProxyAction *action,
return ret;
}
/**
* gupnp_service_proxy_action_get_result_valist:
* @action: A #GUPnPServiceProxyAction handle
* @error: (allow-none): The location where to store any error, or %NULL
* @var_args: A va_list of tuples of out parameter name, out parameter type,
* and out parameter value location. The out parameter values should be
* freed after use
*
* See gupnp_service_proxy_action_get_result().
*
* Return value: %TRUE on success.
**/
gboolean
gupnp_service_proxy_action_get_result_valist (GUPnPServiceProxyAction *action,
GError **error,
......
......@@ -389,6 +389,9 @@ gupnp_service_proxy_class_init (GUPnPServiceProxyClass *klass)
* a UPnPError the error code will be the same in @error.
*
* Return value: %TRUE if sending the action was succesful.
*
* Deprecated: 1.1.2: Use gupnp_service_proxy_action_new() and
* gupnp_service_proxy_call_action()
**/
gboolean
gupnp_service_proxy_send_action (GUPnPServiceProxy *proxy,
......@@ -423,6 +426,8 @@ gupnp_service_proxy_send_action (GUPnPServiceProxy *proxy,
* See gupnp_service_proxy_send_action().
*
* Return value: %TRUE if sending the action was succesful.
*
* Deprecated: 1.1.2
**/
gboolean
gupnp_service_proxy_send_action_valist (GUPnPServiceProxy *proxy,
......@@ -565,7 +570,8 @@ on_legacy_async_callback (GObject *source, GAsyncResult *res, gpointer user_data
* gupnp_service_proxy_cancel_action() or
* gupnp_service_proxy_end_action_valist().
*
* Deprecated: 1.1.1: Use gupnp_service_proxy_action_new() and gupnp_service_proxy_action_call_action_async()
* Deprecated: 1.1.2: Use gupnp_service_proxy_action_new() and
* gupnp_service_proxy_action_call_action_async()
**/
GUPnPServiceProxyAction *
gupnp_service_proxy_begin_action (GUPnPServiceProxy *proxy,
......@@ -868,7 +874,7 @@ finish_action_msg (GUPnPServiceProxyAction *action,
* be freed when calling gupnp_service_proxy_cancel_action() or
* gupnp_service_proxy_end_action_valist().
*
* Deprecated: 1.1.1: Use ove of
* Deprecated: 1.1.2
**/
GUPnPServiceProxyAction *
gupnp_service_proxy_begin_action_valist
......@@ -2085,8 +2091,22 @@ gupnp_service_proxy_get_subscribed (GUPnPServiceProxy *proxy)
/**
* gupnp_service_proxy_call_action_async:
* @proxy: (transfer none): A #GUPnPServiceProxy
* @action: An action
* @cancellable: (allow-none): A #GCancellable which can be used to cancel the
* current action call
* @callback: (scope async): A #GAsyncReadyCallback to call when the action is
* finished.
* @user_data: (closure): User data for @callback
*
* Start a call on the remote UPnP service using the pre-configured @action.
* Use gupnp_service_proxy_call_action_finish() in the @callback to finalize
* the call and gupnp_service_proxy_action_get_result(),
* gupnp_service_proxy_action_get_result_hash() or
* gupnp_service_proxy_action_get_result_list() to extract the result of the
* remote call.
*/
GUPnPServiceProxyAction *
void
gupnp_service_proxy_call_action_async (GUPnPServiceProxy *proxy,
GUPnPServiceProxyAction *action,
GCancellable *cancellable,
......@@ -2095,7 +2115,7 @@ gupnp_service_proxy_call_action_async (GUPnPServiceProxy *proxy,
{
GTask *task;
g_return_val_if_fail (GUPNP_IS_SERVICE_PROXY (proxy), NULL);
g_return_if_fail (GUPNP_IS_SERVICE_PROXY (proxy));
task = g_task_new (proxy, cancellable, callback, user_data);
g_task_set_task_data (task,
......@@ -2107,17 +2127,21 @@ gupnp_service_proxy_call_action_async (GUPnPServiceProxy *proxy,
if (action->error != NULL) {
g_task_return_error (task, g_error_copy (action->error));
g_object_unref (task);
return NULL;
} else {
gupnp_service_proxy_action_queue_task (task);
}
gupnp_service_proxy_action_queue_task (task);
return action;
}
/**
* gupnp_service_proxy_call_action_finish:
* @proxy: a #GUPnPServiceProxy
* @result: a #GAsyncResult
* @error: (allow-none): Return location for a #GError, or %NULL
*
* Finish an asynchronous call initiated with
* gupnp_service_proxy_call_action_async().
*
* Returns: %NULL, if the call had an error, the action otherwise.
*/
GUPnPServiceProxyAction *
gupnp_service_proxy_call_action_finish (GUPnPServiceProxy *proxy,
......@@ -2129,6 +2153,18 @@ gupnp_service_proxy_call_action_finish (GUPnPServiceProxy *proxy,
return g_task_propagate_pointer (G_TASK (result), error);
}
/**
* gupnp_service_proxy_call_action:
* @proxy: (transfer none): A #GUPnPServiceProxy
* @action: An action
* @cancellable: (allow-none): A #GCancellable which can be used to cancel the
* current action call
* @error: (allow-none): Return location for a #GError, or %NULL.
*
* Synchronously call the @action on the remote UPnP service.
*
* Returns: %NULL on error, @action if successful.
*/
GUPnPServiceProxyAction *
gupnp_service_proxy_call_action (GUPnPServiceProxy *proxy,
GUPnPServiceProxyAction *action,
......
......@@ -242,7 +242,7 @@ gupnp_service_proxy_action_get_result_hash (GUPnPServiceProxyAction *action,
GError **error);
GUPnPServiceProxyAction *
void
gupnp_service_proxy_call_action_async (GUPnPServiceProxy *proxy,
GUPnPServiceProxyAction *action,
GCancellable *cancellable,
......
Markdown is supported
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