From 482dc34d7468ddfc08f1a204459dec4d3785f1f6 Mon Sep 17 00:00:00 2001 From: Stef Walter Date: Thu, 17 Oct 2013 08:59:55 +0200 Subject: [PATCH] Fix documentation warnings --- docs/reference/libsecret/libsecret-sections.txt | 2 ++ libsecret/secret-paths.c | 25 ++++++++++++++++++++++++- libsecret/secret-service.c | 4 ++++ libsecret/secret-util.c | 7 +++++++ 4 files changed, 37 insertions(+), 1 deletion(-) diff --git a/docs/reference/libsecret/libsecret-sections.txt b/docs/reference/libsecret/libsecret-sections.txt index a18b89e..d62dd5d 100644 --- a/docs/reference/libsecret/libsecret-sections.txt +++ b/docs/reference/libsecret/libsecret-sections.txt @@ -226,6 +226,8 @@ secret_service_prompt_sync secret_service_set_alias secret_service_set_alias_finish secret_service_set_alias_sync +secret_service_get_collection_gtype +secret_service_get_item_gtype SECRET_IS_SERVICE SECRET_IS_SERVICE_CLASS diff --git a/libsecret/secret-paths.c b/libsecret/secret-paths.c index 8114b79..93e6e94 100644 --- a/libsecret/secret-paths.c +++ b/libsecret/secret-paths.c @@ -242,7 +242,7 @@ secret_item_new_for_dbus_path_finish (GAsyncResult *result, } /** - * secret_item_new_dbus_path_sync: + * secret_item_new_for_dbus_path_sync: * @service: (allow-none): a secret service object * @item_path: the D-Bus path of the item * @flags: initialization flags for the new item @@ -2394,6 +2394,29 @@ secret_service_set_alias_to_dbus_path_sync (SecretService *self, return ret; } +/** + * secret_service_prompt_at_dbus_path_sync: + * @self: the secret service + * @prompt_path: the D-Bus object path of the prompt + * @cancellable: optional cancellation object + * @return_type: (allow-none): the variant type of the prompt result + * @error: location to place error on failure + * + * Perform prompting for a #SecretPrompt. + * + * Override the #SecretServiceClass prompt_async virtual method + * to change the behavior of the propmting. The default behavior is to simply + * run secret_prompt_perform() on the prompt. + * + * Returns a variant result if the prompt was completed and not dismissed. The + * type of result depends on the action the prompt is completing, and is defined + * in the Secret Service DBus API specification. + * + * This method may block and should not be used in user interface threads. + * + * Returns: (transfer full): %NULL if the prompt was dismissed or an error occurred, + * a variant result if the prompt was successful + */ GVariant * secret_service_prompt_at_dbus_path_sync (SecretService *self, const gchar *prompt_path, diff --git a/libsecret/secret-service.c b/libsecret/secret-service.c index 3c9539c..0295c89 100644 --- a/libsecret/secret-service.c +++ b/libsecret/secret-service.c @@ -88,6 +88,10 @@ * @prompt_async: called to perform asynchronous prompting when necessary * @prompt_finish: called to complete an asynchronous prompt operation * @prompt_sync: called to perform synchronous prompting when necessary + * @get_collection_gtype: called to get the GObject type for collections + * instantiated by the #SecretService proxy + * @get_item_gtype: called to get the GObject type for collections + * instantiated by the #SecretService proxy * * The class for #SecretService. */ diff --git a/libsecret/secret-util.c b/libsecret/secret-util.c index e85d3ee..2442d37 100644 --- a/libsecret/secret-util.c +++ b/libsecret/secret-util.c @@ -32,6 +32,13 @@ */ /** + * SECRET_ERROR: + * + * The error domain quark which denotes libsecret specific errors from the + * #SecretError enumeration. + */ + +/** * SecretError: * @SECRET_ERROR_PROTOCOL: received an invalid data or message from the Secret * Service -- 2.7.4