Update documentation for to have correct headers

* Add add more warnings to unstable API documentation
This commit is contained in:
Stef Walter 2012-07-13 13:02:17 +02:00
parent 7816417167
commit 83c8674a03
8 changed files with 29 additions and 8 deletions

View File

@ -1,6 +1,6 @@
<SECTION> <SECTION>
<FILE>secret-collection</FILE> <FILE>secret-collection</FILE>
<INCLUDE>libsecret/secret-unstable.h</INCLUDE> <INCLUDE>libsecret/secret.h</INCLUDE>
SecretCollection SecretCollection
SecretCollectionClass SecretCollectionClass
SecretCollectionFlags SecretCollectionFlags
@ -48,7 +48,7 @@ secret_collection_create_flags_get_type
<SECTION> <SECTION>
<FILE>secret-item</FILE> <FILE>secret-item</FILE>
<INCLUDE>libsecret/secret-unstable.h</INCLUDE> <INCLUDE>libsecret/secret.h</INCLUDE>
SecretItem SecretItem
SecretItemClass SecretItemClass
SecretItemFlags SecretItemFlags
@ -161,7 +161,7 @@ SECRET_TYPE_SCHEMA_ATTRIBUTE_TYPE
<SECTION> <SECTION>
<FILE>secret-prompt</FILE> <FILE>secret-prompt</FILE>
<INCLUDE>libsecret/secret-unstable.h</INCLUDE> <INCLUDE>libsecret/secret.h</INCLUDE>
SecretPrompt SecretPrompt
SecretPromptClass SecretPromptClass
secret_prompt_perform secret_prompt_perform
@ -181,7 +181,7 @@ secret_prompt_get_type
<SECTION> <SECTION>
<FILE>secret-service</FILE> <FILE>secret-service</FILE>
<INCLUDE>libsecret/secret-unstable.h</INCLUDE> <INCLUDE>libsecret/secret.h</INCLUDE>
SecretService SecretService
SecretServiceClass SecretServiceClass
SecretServiceFlags SecretServiceFlags
@ -243,7 +243,7 @@ secret_service_get_type
<SECTION> <SECTION>
<FILE>secret-paths</FILE> <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
secret_collection_new_for_dbus_path_finish secret_collection_new_for_dbus_path_finish
secret_collection_new_for_dbus_path_sync secret_collection_new_for_dbus_path_sync
@ -291,7 +291,7 @@ secret_service_set_alias_to_dbus_path_sync
<SECTION> <SECTION>
<FILE>secret-value</FILE> <FILE>secret-value</FILE>
<INCLUDE>libsecret/secret-unstable.h</INCLUDE> <INCLUDE>libsecret/secret.h</INCLUDE>
SecretValue SecretValue
secret_value_new secret_value_new
secret_value_new_full secret_value_new_full
@ -306,7 +306,7 @@ secret_value_get_type
<SECTION> <SECTION>
<FILE>secret-attributes</FILE> <FILE>secret-attributes</FILE>
<INCLUDE>libsecret/secret-unstable.h</INCLUDE> <INCLUDE>libsecret/secret.h</INCLUDE>
secret_attributes_build secret_attributes_build
secret_attributes_buildv secret_attributes_buildv
</SECTION> </SECTION>

View File

@ -40,6 +40,9 @@
* lookup the items in the collection. There may not be any items exposed when * lookup the items in the collection. There may not be any items exposed when
* the collection is locked. * 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 * Stability: Unstable
*/ */

View File

@ -50,6 +50,9 @@
* *
* Items can be created with secret_item_create() or secret_service_store(). * 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 * Stability: Unstable
*/ */

View File

@ -39,7 +39,10 @@
* Each of the functions accept a variable list of attributes names and their * Each of the functions accept a variable list of attributes names and their
* values. Include a %NULL to terminate the list of attributes. * 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
*/ */
/** /**

View File

@ -36,6 +36,9 @@
* service using the DBus API directly, and only wish to use a few calls * service using the DBus API directly, and only wish to use a few calls
* in libsecret. * in libsecret.
* *
* These functions have an unstable API and may change across versions. Use
* <literal>libsecret-unstable</literal> package to access them.
*
* Stability: Unstable * Stability: Unstable
*/ */

View File

@ -38,6 +38,9 @@
* SecretServiceClass::prompt_async and SecretServiceClass::prompt_finish * SecretServiceClass::prompt_async and SecretServiceClass::prompt_finish
* virtual methods of the #SecretService class. * 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 * Stability: Unstable
*/ */

View File

@ -66,6 +66,9 @@
* In order to customize prompt handling, override the <literal>prompt_async</literal> * In order to customize prompt handling, override the <literal>prompt_async</literal>
* and <literal>prompt_finish</literal> virtual methods of the #SecretService class. * 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 * Stability: Unstable
*/ */

View File

@ -38,6 +38,9 @@
* #SecretValue is reference counted and immutable. The secret data is only * #SecretValue is reference counted and immutable. The secret data is only
* freed when all references have been released via secret_value_unref(). * 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 * Stability: Unstable
*/ */