diff options
author | Maximiliano Sandoval R <msandova@gnome.org> | 2022-02-05 21:09:39 +0100 |
---|---|---|
committer | Maximiliano Sandoval R <msandova@gnome.org> | 2022-02-07 13:02:10 +0100 |
commit | 3f9738bdd477bc09d8f643816636bbfbd432d329 (patch) | |
tree | 4efddd4cf613f13d24c79cbd61af523ee7375bb3 | |
parent | 6d5c9782acb8b095c3fce68dd9d46476c016cb11 (diff) | |
download | libsecret-3f9738bdd477bc09d8f643816636bbfbd432d329.tar.gz |
docs: Document errors
-rw-r--r-- | libsecret/meson.build | 1 | ||||
-rw-r--r-- | libsecret/secret-util.c | 43 |
2 files changed, 19 insertions, 25 deletions
diff --git a/libsecret/meson.build b/libsecret/meson.build index 0b37328..97e0222 100644 --- a/libsecret/meson.build +++ b/libsecret/meson.build @@ -132,6 +132,7 @@ if get_option('introspection') 'secret-types.h', 'secret-value.c', 'secret-value.h', + 'secret-util.c', ] libsecret_gir_sources += version_h libsecret_gir_sources += _enums_generated diff --git a/libsecret/secret-util.c b/libsecret/secret-util.c index 3b601bc..4e6f2bb 100644 --- a/libsecret/secret-util.c +++ b/libsecret/secret-util.c @@ -20,36 +20,22 @@ #include <string.h> /** - * SecretError - * - * libsecret errors - * - * Various errors reported by the libsecret library. No error returned from - * the libsecret API is suitable for direct display to the user. It is up - * to the application to handle them appropriately. - * - * Stability: Stable - */ - -/** - * SECRET_ERROR: - * - * The error domain quark which denotes libsecret specific errors from the - * #SecretError enumeration. - */ - -/** * SecretError: * @SECRET_ERROR_PROTOCOL: received an invalid data or message from the Secret - * Service + * Service * @SECRET_ERROR_IS_LOCKED: the item or collection is locked and the operation - * cannot be performed - * @SECRET_ERROR_NO_SUCH_OBJECT: no such item or collection found in the - * Secret Service + * cannot be performed + * @SECRET_ERROR_NO_SUCH_OBJECT: no such item or collection found in the Secret + * Service * @SECRET_ERROR_ALREADY_EXISTS: a relevant item or collection already exists + * @SECRET_ERROR_INVALID_FILE_FORMAT: the file format is not valid + * + * Errors returned by the Secret Service. * - * Errors returned by the Secret Service. None of the errors are appropriate - * for display to the user. + * None of the errors are appropriate for display to the user. It is up to the + * application to handle them appropriately. + * + * Stability: Stable */ static void @@ -86,6 +72,13 @@ _secret_list_get_type (void) } +/** + * secret_error_get_quark: + * + * Get the error quark. + * + * Returns: the quark + */ GQuark secret_error_get_quark (void) { |