summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStef Walter <stefw@gnome.org>2012-07-13 13:02:17 +0200
committerStef Walter <stefw@gnome.org>2012-07-13 13:04:26 +0200
commit83c8674a03bb3373daa63be3eb44385d10bff968 (patch)
tree777142108445ecb9652a27e28fdcc620b1fc5620
parent7816417167bb0656b9d176890ebb1af793d1b17d (diff)
downloadlibsecret-0.5.tar.gz
Update documentation for to have correct headers0.5
* Add add more warnings to unstable API documentation
-rw-r--r--docs/reference/libsecret/libsecret-sections.txt14
-rw-r--r--libsecret/secret-collection.c3
-rw-r--r--libsecret/secret-item.c3
-rw-r--r--libsecret/secret-password.c5
-rw-r--r--libsecret/secret-paths.c3
-rw-r--r--libsecret/secret-prompt.c3
-rw-r--r--libsecret/secret-service.c3
-rw-r--r--libsecret/secret-value.c3
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 @@
<SECTION>
<FILE>secret-collection</FILE>
-<INCLUDE>libsecret/secret-unstable.h</INCLUDE>
+<INCLUDE>libsecret/secret.h</INCLUDE>
SecretCollection
SecretCollectionClass
SecretCollectionFlags
@@ -48,7 +48,7 @@ secret_collection_create_flags_get_type
<SECTION>
<FILE>secret-item</FILE>
-<INCLUDE>libsecret/secret-unstable.h</INCLUDE>
+<INCLUDE>libsecret/secret.h</INCLUDE>
SecretItem
SecretItemClass
SecretItemFlags
@@ -161,7 +161,7 @@ SECRET_TYPE_SCHEMA_ATTRIBUTE_TYPE
<SECTION>
<FILE>secret-prompt</FILE>
-<INCLUDE>libsecret/secret-unstable.h</INCLUDE>
+<INCLUDE>libsecret/secret.h</INCLUDE>
SecretPrompt
SecretPromptClass
secret_prompt_perform
@@ -181,7 +181,7 @@ secret_prompt_get_type
<SECTION>
<FILE>secret-service</FILE>
-<INCLUDE>libsecret/secret-unstable.h</INCLUDE>
+<INCLUDE>libsecret/secret.h</INCLUDE>
SecretService
SecretServiceClass
SecretServiceFlags
@@ -243,7 +243,7 @@ secret_service_get_type
<SECTION>
<FILE>secret-paths</FILE>
-<INCLUDE>libsecret/secret-unstable.h</INCLUDE>
+<INCLUDE>libsecret/secret.h</INCLUDE>
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
<SECTION>
<FILE>secret-value</FILE>
-<INCLUDE>libsecret/secret-unstable.h</INCLUDE>
+<INCLUDE>libsecret/secret.h</INCLUDE>
SecretValue
secret_value_new
secret_value_new_full
@@ -306,7 +306,7 @@ secret_value_get_type
<SECTION>
<FILE>secret-attributes</FILE>
-<INCLUDE>libsecret/secret-unstable.h</INCLUDE>
+<INCLUDE>libsecret/secret.h</INCLUDE>
secret_attributes_build
secret_attributes_buildv
</SECTION>
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
+ * <literal>libsecret-unstable</literal> 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
+ * <literal>libsecret-unstable</literal> 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
+ * <literal>libsecret-unstable</literal> 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
+ * <literal>libsecret-unstable</literal> 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
+ * <literal>libsecret-unstable</literal> 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 <literal>prompt_async</literal>
* and <literal>prompt_finish</literal> virtual methods of the #SecretService class.
*
+ * These functions have an unstable API and may change across versions. Use
+ * <literal>libsecret-unstable</literal> 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
+ * <literal>libsecret-unstable</literal> package to access them.
+ *
* Stability: Unstable
*/