From 83c8674a03bb3373daa63be3eb44385d10bff968 Mon Sep 17 00:00:00 2001 From: Stef Walter Date: Fri, 13 Jul 2012 13:02:17 +0200 Subject: [PATCH] Update documentation for to have correct headers * Add add more warnings to unstable API documentation --- docs/reference/libsecret/libsecret-sections.txt | 14 +++++++------- libsecret/secret-collection.c | 3 +++ libsecret/secret-item.c | 3 +++ libsecret/secret-password.c | 5 ++++- libsecret/secret-paths.c | 3 +++ libsecret/secret-prompt.c | 3 +++ libsecret/secret-service.c | 3 +++ libsecret/secret-value.c | 3 +++ 8 files changed, 29 insertions(+), 8 deletions(-) diff --git a/docs/reference/libsecret/libsecret-sections.txt b/docs/reference/libsecret/libsecret-sections.txt index d51a649..d7f0f80 100644 --- a/docs/reference/libsecret/libsecret-sections.txt +++ b/docs/reference/libsecret/libsecret-sections.txt @@ -1,6 +1,6 @@
secret-collection -libsecret/secret-unstable.h +libsecret/secret.h SecretCollection SecretCollectionClass SecretCollectionFlags @@ -48,7 +48,7 @@ secret_collection_create_flags_get_type
secret-item -libsecret/secret-unstable.h +libsecret/secret.h SecretItem SecretItemClass SecretItemFlags @@ -161,7 +161,7 @@ SECRET_TYPE_SCHEMA_ATTRIBUTE_TYPE
secret-prompt -libsecret/secret-unstable.h +libsecret/secret.h SecretPrompt SecretPromptClass secret_prompt_perform @@ -181,7 +181,7 @@ secret_prompt_get_type
secret-service -libsecret/secret-unstable.h +libsecret/secret.h SecretService SecretServiceClass SecretServiceFlags @@ -243,7 +243,7 @@ secret_service_get_type
secret-paths -libsecret/secret-unstable.h +libsecret/secret.h secret_collection_new_for_dbus_path secret_collection_new_for_dbus_path_finish secret_collection_new_for_dbus_path_sync @@ -291,7 +291,7 @@ secret_service_set_alias_to_dbus_path_sync
secret-value -libsecret/secret-unstable.h +libsecret/secret.h SecretValue secret_value_new secret_value_new_full @@ -306,7 +306,7 @@ secret_value_get_type
secret-attributes -libsecret/secret-unstable.h +libsecret/secret.h secret_attributes_build secret_attributes_buildv
diff --git a/libsecret/secret-collection.c b/libsecret/secret-collection.c index 1165e12..b590c5c 100644 --- a/libsecret/secret-collection.c +++ b/libsecret/secret-collection.c @@ -40,6 +40,9 @@ * lookup the items in the collection. There may not be any items exposed when * the collection is locked. * + * These functions have an unstable API and may change across versions. Use + * libsecret-unstable package to access them. + * * Stability: Unstable */ diff --git a/libsecret/secret-item.c b/libsecret/secret-item.c index ca4c107..49a9dba 100644 --- a/libsecret/secret-item.c +++ b/libsecret/secret-item.c @@ -50,6 +50,9 @@ * * Items can be created with secret_item_create() or secret_service_store(). * + * These functions have an unstable API and may change across versions. Use + * libsecret-unstable package to access them. + * * Stability: Unstable */ diff --git a/libsecret/secret-password.c b/libsecret/secret-password.c index f506596..5f2288b 100644 --- a/libsecret/secret-password.c +++ b/libsecret/secret-password.c @@ -39,7 +39,10 @@ * Each of the functions accept a variable list of attributes names and their * values. Include a %NULL to terminate the list of attributes. * - * Stability: Stable + * These functions have an unstable API and may change across versions. Use + * libsecret-unstable package to access them. + * + * Stability: Unstable */ /** diff --git a/libsecret/secret-paths.c b/libsecret/secret-paths.c index 60df179..dea7097 100644 --- a/libsecret/secret-paths.c +++ b/libsecret/secret-paths.c @@ -36,6 +36,9 @@ * service using the DBus API directly, and only wish to use a few calls * in libsecret. * + * These functions have an unstable API and may change across versions. Use + * libsecret-unstable package to access them. + * * Stability: Unstable */ diff --git a/libsecret/secret-prompt.c b/libsecret/secret-prompt.c index 6d8e2f8..029739a 100644 --- a/libsecret/secret-prompt.c +++ b/libsecret/secret-prompt.c @@ -38,6 +38,9 @@ * SecretServiceClass::prompt_async and SecretServiceClass::prompt_finish * virtual methods of the #SecretService class. * + * These functions have an unstable API and may change across versions. Use + * libsecret-unstable package to access them. + * * Stability: Unstable */ diff --git a/libsecret/secret-service.c b/libsecret/secret-service.c index eea9b18..6d4218b 100644 --- a/libsecret/secret-service.c +++ b/libsecret/secret-service.c @@ -66,6 +66,9 @@ * In order to customize prompt handling, override the prompt_async * and prompt_finish virtual methods of the #SecretService class. * + * These functions have an unstable API and may change across versions. Use + * libsecret-unstable package to access them. + * * Stability: Unstable */ diff --git a/libsecret/secret-value.c b/libsecret/secret-value.c index 9b46c48..7bd7bc2 100644 --- a/libsecret/secret-value.c +++ b/libsecret/secret-value.c @@ -38,6 +38,9 @@ * #SecretValue is reference counted and immutable. The secret data is only * freed when all references have been released via secret_value_unref(). * + * These functions have an unstable API and may change across versions. Use + * libsecret-unstable package to access them. + * * Stability: Unstable */