Update documentation for to have correct headers
authorStef Walter <stefw@gnome.org>
Fri, 13 Jul 2012 11:02:17 +0000 (13:02 +0200)
committerStef Walter <stefw@gnome.org>
Fri, 13 Jul 2012 11:04:26 +0000 (13:04 +0200)
 * Add add more warnings to unstable API documentation

docs/reference/libsecret/libsecret-sections.txt
libsecret/secret-collection.c
libsecret/secret-item.c
libsecret/secret-password.c
libsecret/secret-paths.c
libsecret/secret-prompt.c
libsecret/secret-service.c
libsecret/secret-value.c

index d51a649..d7f0f80 100644 (file)
@@ -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>
index 1165e12..b590c5c 100644 (file)
@@ -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
  */
 
index ca4c107..49a9dba 100644 (file)
@@ -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
  */
 
index f506596..5f2288b 100644 (file)
  * 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
  */
 
 /**
index 60df179..dea7097 100644 (file)
@@ -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
  */
 
index 6d8e2f8..029739a 100644 (file)
@@ -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
  */
 
index eea9b18..6d4218b 100644 (file)
@@ -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
  */
 
index 9b46c48..7bd7bc2 100644 (file)
@@ -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
  */