diff options
| author | Niels De Graef <nielsdegraef@gmail.com> | 2022-02-12 10:52:27 +0000 |
|---|---|---|
| committer | Niels De Graef <nielsdegraef@gmail.com> | 2022-02-12 10:52:27 +0000 |
| commit | e984e7bb67d8d9577fa3b6053c69380f09654e81 (patch) | |
| tree | bb8095689e755e1b5fe431d543f18e206b1ff421 /libsecret/secret-value.c | |
| parent | e762e39dfcccbbad39b4cbd0cae1cd919757301b (diff) | |
| parent | b4b701cc8fd9f42e0b40f71791f3a354c1d3355d (diff) | |
| download | libsecret-e984e7bb67d8d9577fa3b6053c69380f09654e81.tar.gz | |
Merge branch 'doc-fixes' into 'master'
Improvements to documentation and annotations
See merge request GNOME/libsecret!103
Diffstat (limited to 'libsecret/secret-value.c')
| -rw-r--r-- | libsecret/secret-value.c | 36 |
1 files changed, 23 insertions, 13 deletions
diff --git a/libsecret/secret-value.c b/libsecret/secret-value.c index 19a2131..a6f3760 100644 --- a/libsecret/secret-value.c +++ b/libsecret/secret-value.c @@ -75,8 +75,9 @@ secret_value_get_type (void) * @length: the length of the data * @content_type: the content type of the data * - * Create a #SecretValue for the secret data passed in. The secret data is - * copied into non-pageable 'secure' memory. + * Create a #SecretValue for the secret data passed in. + * + * The secret data is copied into non-pageable 'secure' memory. * * If the length is less than zero, then @secret is assumed to be * null-terminated. @@ -110,8 +111,10 @@ secret_value_new (const gchar *secret, * @content_type: the content type of the data * @destroy: function to call to free the secret data * - * Create a #SecretValue for the secret data passed in. The secret data is - * not copied, and will later be freed with the @destroy function. + * Create a #SecretValue for the secret data passed in. + * + * The secret data is not copied, and will later be freed with the @destroy + * function. * * If the length is less than zero, then @secret is assumed to be * null-terminated. @@ -146,9 +149,11 @@ secret_value_new_full (gchar *secret, * @value: the value * @length: the length of the secret * - * Get the secret data in the #SecretValue. The value is not necessarily - * null-terminated unless it was created with [ctor@Value.new] or a - * null-terminated string was passed to [ctor@Value.new_full]. + * Get the secret data in the #SecretValue. + * + * The value is not necessarily null-terminated unless it was created with + * [ctor@Value.new] or a null-terminated string was passed to + * [ctor@Value.new_full]. * * Returns: (array length=length) (element-type guint8): the secret data */ @@ -167,7 +172,9 @@ secret_value_get (SecretValue *value, * @value: the value * * Get the secret data in the #SecretValue if it contains a textual - * value. The content type must be `text/plain`. + * value. + * + * The content type must be `text/plain`. * * Returns: (nullable): the content type */ @@ -202,8 +209,10 @@ secret_value_get_content_type (SecretValue *value) * secret_value_ref: * @value: value to reference * - * Add another reference to the #SecretValue. For each reference - * [method@Value.unref] should be called to unreference the value. + * Add another reference to the #SecretValue. + * + * For each reference [method@Value.unref] should be called to unreference the + * value. * * Returns: (transfer full): the value */ @@ -219,8 +228,9 @@ secret_value_ref (SecretValue *value) * secret_value_unref: * @value: (type Secret.Value): value to unreference * - * Unreference a #SecretValue. When the last reference is gone, then - * the value will be freed. + * Unreference a #SecretValue. + * + * When the last reference is gone, then the value will be freed. */ void secret_value_unref (gpointer value) @@ -253,7 +263,7 @@ is_password_value (SecretValue *value) /** * secret_value_unref_to_password: * @value: the value - * @length: the length of the secret + * @length: (inout): the length of the secret * * Unreference a #SecretValue and steal the secret data in * #SecretValue as nonpageable memory. |