Cypher_Stack/libsecret
2
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/libsecret.git synced 2024-12-22 12:48:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Mark NULL with appropriate gtk-doc prefix

Browse Source 
This looks cleaner for the docs generated by the several bindings.
This commit is contained in:
Niels De Graef 2021-02-06 10:54:10 +01:00
parent 41c8a8282f
commit 82fe5dada1
3 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
libsecret/secret-collection.c
View File

@ -1077,7 +1077,7 @@ _secret_collection_properties_new (const gchar *label)
* collection with that alias already exists, then a new collection will not * collection with that alias already exists, then a new collection will not
* be created. The previous one will be returned instead. * be created. The previous one will be returned instead.
* *
* If @service is NULL, then secret_service_get() will be called to get * If @service is %NULL, then secret_service_get() will be called to get
* the default #SecretService proxy. * the default #SecretService proxy.
* *
*/ */
@ -1174,7 +1174,7 @@ secret_collection_create_finish (GAsyncResult *result,
* collection with that alias already exists, then a new collection will not * collection with that alias already exists, then a new collection will not
* be created. The previous one will be returned instead. * be created. The previous one will be returned instead.
* *
* If @service is NULL, then secret_service_get_sync() will be called to get * If @service is %NULL, then secret_service_get_sync() will be called to get
* the default #SecretService proxy. * the default #SecretService proxy.
* *
* Returns: (transfer full): the new collection, which should be unreferenced * Returns: (transfer full): the new collection, which should be unreferenced
@ -2114,7 +2114,7 @@ on_read_alias_service (GObject *source,
* Lookup which collection is assigned to this alias. Aliases help determine * Lookup which collection is assigned to this alias. Aliases help determine
* well known collections, such as 'default'. * well known collections, such as 'default'.
* *
* If @service is NULL, then secret_service_get() will be called to get * If @service is %NULL, then secret_service_get() will be called to get
* the default #SecretService proxy. * the default #SecretService proxy.
* *
* This method will return immediately and complete asynchronously. * This method will return immediately and complete asynchronously.
@ -2194,7 +2194,7 @@ secret_collection_for_alias_finish (GAsyncResult *result,
* Lookup which collection is assigned to this alias. Aliases help determine * Lookup which collection is assigned to this alias. Aliases help determine
* well known collections, such as 'default'. * well known collections, such as 'default'.
* *
* If @service is NULL, then secret_service_get_sync() will be called to get * If @service is %NULL, then secret_service_get_sync() will be called to get
* the default #SecretService proxy. * the default #SecretService proxy.
* *
* This method may block and should not be used in user interface threads. * This method may block and should not be used in user interface threads.

28
libsecret/secret-methods.c
View File

@ -270,7 +270,7 @@ on_search_service (GObject *source,
* Search for items matching the @attributes. All collections are searched. * Search for items matching the @attributes. All collections are searched.
* The @attributes should be a table of string keys and string values. * The @attributes should be a table of string keys and string values.
* *
* If @service is NULL, then secret_service_get() will be called to get * If @service is %NULL, then secret_service_get() will be called to get
* the default #SecretService proxy. * the default #SecretService proxy.
* *
* If %SECRET_SEARCH_ALL is set in @flags, then all the items matching the * If %SECRET_SEARCH_ALL is set in @flags, then all the items matching the
@ -413,7 +413,7 @@ service_load_items_sync (SecretService *service,
* Search for items matching the @attributes. All collections are searched. * Search for items matching the @attributes. All collections are searched.
* The @attributes should be a table of string keys and string values. * The @attributes should be a table of string keys and string values.
* *
* If @service is NULL, then secret_service_get_sync() will be called to get * If @service is %NULL, then secret_service_get_sync() will be called to get
* the default #SecretService proxy. * the default #SecretService proxy.
* *
* If %SECRET_SEARCH_ALL is set in @flags, then all the items matching the * If %SECRET_SEARCH_ALL is set in @flags, then all the items matching the
@ -737,7 +737,7 @@ service_xlock_finish (SecretService *service,
* The secret service may not be able to lock items individually, and may * The secret service may not be able to lock items individually, and may
* lock an entire collection instead. * lock an entire collection instead.
* *
* If @service is NULL, then secret_service_get() will be called to get * If @service is %NULL, then secret_service_get() will be called to get
* the default #SecretService proxy. * the default #SecretService proxy.
* *
* This method returns immediately and completes asynchronously. The secret * This method returns immediately and completes asynchronously. The secret
@ -799,7 +799,7 @@ secret_service_lock_finish (SecretService *service,
* The secret service may not be able to lock items individually, and may * The secret service may not be able to lock items individually, and may
* lock an entire collection instead. * lock an entire collection instead.
* *
* If @service is NULL, then secret_service_get_sync() will be called to get * If @service is %NULL, then secret_service_get_sync() will be called to get
* the default #SecretService proxy. * the default #SecretService proxy.
* *
* This method may block indefinitely and should not be used in user * This method may block indefinitely and should not be used in user
@ -851,7 +851,7 @@ secret_service_lock_sync (SecretService *service,
* The secret service may not be able to unlock items individually, and may * The secret service may not be able to unlock items individually, and may
* unlock an entire collection instead. * unlock an entire collection instead.
* *
* If @service is NULL, then secret_service_get() will be called to get * If @service is %NULL, then secret_service_get() will be called to get
* the default #SecretService proxy. * the default #SecretService proxy.
* *
* This method may block indefinitely and should not be used in user * This method may block indefinitely and should not be used in user
@ -913,7 +913,7 @@ secret_service_unlock_finish (SecretService *service,
* The secret service may not be able to unlock items individually, and may * The secret service may not be able to unlock items individually, and may
* unlock an entire collection instead. * unlock an entire collection instead.
* *
* If @service is NULL, then secret_service_get_sync() will be called to get * If @service is %NULL, then secret_service_get_sync() will be called to get
* the default #SecretService proxy. * the default #SecretService proxy.
* *
* This method may block indefinitely and should not be used in user * This method may block indefinitely and should not be used in user
@ -1120,7 +1120,7 @@ on_store_service (GObject *source,
* If the attributes match a secret item already stored in the collection, then * If the attributes match a secret item already stored in the collection, then
* the item will be updated with these new values. * the item will be updated with these new values.
* *
* If @service is NULL, then secret_service_get() will be called to get * If @service is %NULL, then secret_service_get() will be called to get
* the default #SecretService proxy. * the default #SecretService proxy.
* *
* If @collection is not specified, then the default collection will be * If @collection is not specified, then the default collection will be
@ -1241,7 +1241,7 @@ secret_service_store_finish (SecretService *service,
* used. Use #SECRET_COLLECTION_SESSION to store the password in the session * used. Use #SECRET_COLLECTION_SESSION to store the password in the session
* collection, which doesn't get stored across login sessions. * collection, which doesn't get stored across login sessions.
* *
* If @service is NULL, then secret_service_get_sync() will be called to get * If @service is %NULL, then secret_service_get_sync() will be called to get
* the default #SecretService proxy. * the default #SecretService proxy.
* *
* This method may block indefinitely and should not be used in user interface * This method may block indefinitely and should not be used in user interface
@ -1432,7 +1432,7 @@ on_lookup_service (GObject *source,
* *
* The @attributes should be a set of key and value string pairs. * The @attributes should be a set of key and value string pairs.
* *
* If @service is NULL, then secret_service_get() will be called to get * If @service is %NULL, then secret_service_get() will be called to get
* the default #SecretService proxy. * the default #SecretService proxy.
* *
* This method will return immediately and complete asynchronously. * This method will return immediately and complete asynchronously.
@ -1529,7 +1529,7 @@ secret_service_lookup_finish (SecretService *service,
* *
* The @attributes should be a set of key and value string pairs. * The @attributes should be a set of key and value string pairs.
* *
* If @service is NULL, then secret_service_get_sync() will be called to get * If @service is %NULL, then secret_service_get_sync() will be called to get
* the default #SecretService proxy. * the default #SecretService proxy.
* *
* This method may block indefinitely and should not be used in user interface * This method may block indefinitely and should not be used in user interface
@ -1683,7 +1683,7 @@ on_delete_service (GObject *source,
* *
* The @attributes should be a set of key and value string pairs. * The @attributes should be a set of key and value string pairs.
* *
* If @service is NULL, then secret_service_get() will be called to get * If @service is %NULL, then secret_service_get() will be called to get
* the default #SecretService proxy. * the default #SecretService proxy.
* *
* This method will return immediately and complete asynchronously. * This method will return immediately and complete asynchronously.
@ -1779,7 +1779,7 @@ secret_service_clear_finish (SecretService *service,
* *
* The @attributes should be a set of key and value string pairs. * The @attributes should be a set of key and value string pairs.
* *
* If @service is NULL, then secret_service_get_sync() will be called to get * If @service is %NULL, then secret_service_get_sync() will be called to get
* the default #SecretService proxy. * the default #SecretService proxy.
* *
* This method may block indefinitely and should not be used in user interface * This method may block indefinitely and should not be used in user interface
@ -1893,7 +1893,7 @@ on_set_alias_service (GObject *source,
* Assign a collection to this alias. Aliases help determine * Assign a collection to this alias. Aliases help determine
* well known collections, such as 'default'. * well known collections, such as 'default'.
* *
* If @service is NULL, then secret_service_get() will be called to get * If @service is %NULL, then secret_service_get() will be called to get
* the default #SecretService proxy. * the default #SecretService proxy.
* *
* This method will return immediately and complete asynchronously. * This method will return immediately and complete asynchronously.
@ -1982,7 +1982,7 @@ secret_service_set_alias_finish (SecretService *service,
* Assign a collection to this alias. Aliases help determine * Assign a collection to this alias. Aliases help determine
* well known collections, such as 'default'. * well known collections, such as 'default'.
* *
* If @service is NULL, then secret_service_get_sync() will be called to get * If @service is %NULL, then secret_service_get_sync() will be called to get
* the default #SecretService proxy. * the default #SecretService proxy.
* *
* This method may block and should not be used in user interface threads. * This method may block and should not be used in user interface threads.

8
libsecret/secret-paths.c
View File

@ -50,7 +50,7 @@
* *
* Get a new collection proxy for a collection in the secret service. * Get a new collection proxy for a collection in the secret service.
* *
* If @service is NULL, then secret_service_get() will be called to get * If @service is %NULL, then secret_service_get() will be called to get
* the default #SecretService proxy. * the default #SecretService proxy.
* *
* This method will return immediately and complete asynchronously. * This method will return immediately and complete asynchronously.
@ -128,7 +128,7 @@ secret_collection_new_for_dbus_path_finish (GAsyncResult *result,
* *
* Get a new collection proxy for a collection in the secret service. * Get a new collection proxy for a collection in the secret service.
* *
* If @service is NULL, then secret_service_get_sync() will be called to get * If @service is %NULL, then secret_service_get_sync() will be called to get
* the default #SecretService proxy. * the default #SecretService proxy.
* *
* This method may block indefinitely and should not be used in user interface * This method may block indefinitely and should not be used in user interface
@ -179,7 +179,7 @@ secret_collection_new_for_dbus_path_sync (SecretService *service,
* *
* Get a new item proxy for a secret item in the secret service. * Get a new item proxy for a secret item in the secret service.
* *
* If @service is NULL, then secret_service_get() will be called to get * If @service is %NULL, then secret_service_get() will be called to get
* the default #SecretService proxy. * the default #SecretService proxy.
* *
* This method will return immediately and complete asynchronously. * This method will return immediately and complete asynchronously.
@ -256,7 +256,7 @@ secret_item_new_for_dbus_path_finish (GAsyncResult *result,
* *
* Get a new item proxy for a secret item in the secret service. * Get a new item proxy for a secret item in the secret service.
* *
* If @service is NULL, then secret_service_get_sync() will be called to get * If @service is %NULL, then secret_service_get_sync() will be called to get
* the default #SecretService proxy. * the default #SecretService proxy.
* *
* This method may block indefinitely and should not be used in user interface * This method may block indefinitely and should not be used in user interface