GNOME.org
 

[gcr/wip/nielsdg/no-allow-none: 3/3] Mark GIR constants as such

commit 988127e5f9c0f47d9e02ba10ed7d64220604ef6b
Author: Niels De Graef <nielsdegraef gmail com>
Date:   Mon Dec 23 11:52:21 2019 +0100

    Mark GIR constants as such
    
    It doesn't matter really for bindings, but looks better when they are
    rendering documentation (e.g. `NULL` is replaced by `None` for python).

 gck/gck-attributes.c         |  6 +--
 gck/gck-module.c             |  9 +++--
 gck/gck-object.c             | 33 +++++++--------
 gck/gck-session.c            | 96 ++++++++++++++++++++++----------------------
 gck/gck-slot.c               | 21 +++++-----
 gcr/gcr-certificate-chain.c  |  4 +-
 gcr/gcr-certificate.c        |  8 ++--
 gcr/gcr-gnupg-key.c          |  2 +-
 gcr/gcr-library.c            |  2 +-
 gcr/gcr-pkcs11-certificate.c |  4 +-
 gcr/gcr-trust.c              | 16 ++++----
 11 files changed, 102 insertions(+), 99 deletions(-)
---
diff --git a/gck/gck-attributes.c b/gck/gck-attributes.c
index aa2fd75..7d5482c 100644
--- a/gck/gck-attributes.c
+++ b/gck/gck-attributes.c
@@ -1380,7 +1380,7 @@ gck_builder_clear (GckBuilder *builder)
 /**
  * GckAttribute:
  * @type: The attribute type, such as CKA_LABEL.
- * @value: (array length=length): The value of the attribute. May be NULL.
+ * @value: (array length=length): The value of the attribute. May be %NULL.
  * @length: The length of the attribute. May be GCK_INVALID if the attribute is invalid.
  *
  * This structure represents a PKCS11 CK_ATTRIBUTE.
@@ -2057,10 +2057,10 @@ gck_attribute_hash (gconstpointer attr)
  * An allocator used to allocate data for the attributes in this GckAttributes set.
  *
  * This is a function that acts like g_realloc. Specifically it frees when length is
- * set to zero, it allocates when data is set to NULL, and it reallocates when both
+ * set to zero, it allocates when data is set to %NULL, and it reallocates when both
  * are valid.
  *
- * Returns: The allocated memory, or NULL when freeing.
+ * Returns: The allocated memory, or %NULL when freeing.
  **/
 
 GType
diff --git a/gck/gck-module.c b/gck/gck-module.c
index 9e381b1..b8b1aa0 100644
--- a/gck/gck-module.c
+++ b/gck/gck-module.c
@@ -65,7 +65,7 @@
  * Holds information about the PKCS&num;11 module.
  *
  * This structure corresponds to CK_MODULE_INFO in the PKCS\#11 standard. The
- * strings are NULL terminated for easier use.
+ * strings are %NULL terminated for easier use.
  *
  * Use gck_module_info_free() to release this structure when done with it.
  */
@@ -308,7 +308,7 @@ gck_module_info_copy (GckModuleInfo *module_info)
 
 /**
  * gck_module_info_free:
- * @module_info: The module info to free, or NULL.
+ * @module_info: The module info to free, or %NULL.
  *
  * Free a GckModuleInfo structure.
  **/
@@ -444,7 +444,7 @@ gck_module_initialize_async (const gchar *path,
  *
  * Finishes the asynchronous initialize operation.
  *
- * Returns: (transfer full) (nullable): The initialized module, or NULL
+ * Returns: (transfer full) (nullable): The initialized module, or %NULL
  */
 GckModule *
 gck_module_initialize_finish (GAsyncResult *result,
@@ -503,7 +503,8 @@ _gck_module_new_initialized (CK_FUNCTION_LIST_PTR funcs)
  * Checks equality of two modules. Two GckModule objects can point to the same
  * underlying PKCS\#11 module.
  *
- * Return value: TRUE if module1 and module2 are equal. FALSE if either is not a GckModule.
+ * Return value: %TRUE if module1 and module2 are equal.
+ *               %FALSE if either is not a GckModule.
  **/
 gboolean
 gck_module_equal (gconstpointer module1, gconstpointer module2)
diff --git a/gck/gck-object.c b/gck/gck-object.c
index b202cd1..07f26c9 100644
--- a/gck/gck-object.c
+++ b/gck/gck-object.c
@@ -266,7 +266,8 @@ gck_objects_from_handle_array (GckSession *session,
  * Checks equality of two objects. Two GckObject objects can point to the same
  * underlying PKCS\#11 object.
  *
- * Return value: TRUE if object1 and object2 are equal. FALSE if either is not a GckObject.
+ * Return value: %TRUE if object1 and object2 are equal.
+ *               %FALSE if either is not a GckObject.
  **/
 gboolean
 gck_object_equal (gconstpointer object1, gconstpointer object2)
@@ -399,7 +400,7 @@ perform_destroy (Destroy *args)
 /**
  * gck_object_destroy:
  * @self: The object to destroy.
- * @cancellable: Optional cancellable object, or NULL to ignore.
+ * @cancellable: Optional cancellable object, or %NULL to ignore.
  * @error: A location to return an error.
  *
  * Destroy a PKCS\#11 object, deleting it from storage or the session.
@@ -423,7 +424,7 @@ gck_object_destroy (GckObject *self, GCancellable *cancellable, GError **error)
 /**
  * gck_object_destroy_async:
  * @self: The object to destroy.
- * @cancellable: Optional cancellable object, or NULL to ignore.
+ * @cancellable: Optional cancellable object, or %NULL to ignore.
  * @callback: Callback which is called when operation completes.
  * @user_data: Data to pass to the callback.
  *
@@ -499,7 +500,7 @@ free_set_attributes (SetAttributes *args)
  * gck_object_set:
  * @self: The object to set attributes on.
  * @attrs: The attributes to set on the object.
- * @cancellable: Optional cancellable object, or NULL to ignore.
+ * @cancellable: Optional cancellable object, or %NULL to ignore.
  * @error: A location to return an error.
  *
  * Set PKCS\#11 attributes on an object. This call may block for an indefinite period.
@@ -536,7 +537,7 @@ gck_object_set (GckObject *self, GckAttributes *attrs,
  * gck_object_set_async:
  * @self: The object to set attributes on.
  * @attrs: The attributes to set on the object.
- * @cancellable: Optional cancellable object, or NULL to ignore.
+ * @cancellable: Optional cancellable object, or %NULL to ignore.
  * @callback: Callback which is called when operation completes.
  * @user_data: Data to pass to the callback.
  *
@@ -783,7 +784,7 @@ gck_object_get_async (GckObject *self,
  * No extra references are added to the returned attributes pointer.
  *
  * Return value: The filled in attributes structure if successful or
- * NULL if not successful.
+ * %NULL if not successful.
  **/
 GckAttributes*
 gck_object_get_finish (GckObject *self, GAsyncResult *result, GError **error)
@@ -893,8 +894,8 @@ gck_object_get_data (GckObject *self,
  * gck_object_get_data_full: (skip)
  * @self: The object to get attribute data from.
  * @attr_type: The attribute to get data for.
- * @allocator: An allocator with which to allocate memory for the data, or NULL for default.
- * @cancellable: Optional cancellation object, or NULL.
+ * @allocator: An allocator with which to allocate memory for the data, or %NULL for default.
+ * @cancellable: Optional cancellation object, or %NULL.
  * @n_data: The length of the resulting data.
  * @error: A location to store an error.
  *
@@ -942,8 +943,8 @@ gck_object_get_data_full (GckObject *self, gulong attr_type, GckAllocator alloca
  * gck_object_get_data_async:
  * @self: The object to get attribute data from.
  * @attr_type: The attribute to get data for.
- * @allocator: (skip): An allocator with which to allocate memory for the data, or NULL for default.
- * @cancellable: Optional cancellation object, or NULL.
+ * @allocator: (skip): An allocator with which to allocate memory for the data, or %NULL for default.
+ * @cancellable: Optional cancellation object, or %NULL.
  * @callback: Called when the operation completes.
  * @user_data: Data to be passed to the callback.
  *
@@ -1052,7 +1053,7 @@ free_set_template (set_template_args *args)
  * @self: The object to set an attribute template on.
  * @attr_type: The attribute template type.
  * @attrs: The attribute template.
- * @cancellable: Optional cancellation object, or NULL.
+ * @cancellable: Optional cancellation object, or %NULL.
  * @error: A location to store an error.
  *
  * Set an attribute template on the object. The attr_type must be for
@@ -1062,7 +1063,7 @@ free_set_template (set_template_args *args)
  *
  * This call may block for an indefinite period.
  *
- * Return value: TRUE if the operation succeeded.
+ * Return value: %TRUE if the operation succeeded.
  **/
 gboolean
 gck_object_set_template (GckObject *self, gulong attr_type, GckAttributes *attrs,
@@ -1094,7 +1095,7 @@ gck_object_set_template (GckObject *self, gulong attr_type, GckAttributes *attrs
  * @self: The object to set an attribute template on.
  * @attr_type: The attribute template type.
  * @attrs: The attribute template.
- * @cancellable: Optional cancellation object, or NULL.
+ * @cancellable: Optional cancellation object, or %NULL.
  * @callback: Called when the operation completes.
  * @user_data: Data to be passed to the callback.
  *
@@ -1134,7 +1135,7 @@ gck_object_set_template_async (GckObject *self, gulong attr_type, GckAttributes
  * Get the result of an operation to set attribute template on
  * an object.
  *
- * Return value: TRUE if the operation succeeded.
+ * Return value: %TRUE if the operation succeeded.
  **/
 gboolean
 gck_object_set_template_finish (GckObject *self, GAsyncResult *result, GError **error)
@@ -1214,7 +1215,7 @@ free_get_template (get_template_args *args)
  * gck_object_get_template:
  * @self: The object to get an attribute template from.
  * @attr_type: The template attribute type.
- * @cancellable: Optional cancellation object, or NULL.
+ * @cancellable: Optional cancellation object, or %NULL.
  * @error: A location to store an error.
  *
  * Get an attribute template from the object. The attr_type must be for
@@ -1254,7 +1255,7 @@ gck_object_get_template (GckObject *self, gulong attr_type,
  * gck_object_get_template_async:
  * @self: The object to get an attribute template from.
  * @attr_type: The template attribute type.
- * @cancellable: Optional cancellation object, or NULL.
+ * @cancellable: Optional cancellation object, or %NULL.
  * @callback: Called when the operation completes.
  * @user_data: Data to be passed to the callback.
  *
diff --git a/gck/gck-session.c b/gck/gck-session.c
index a55dfaf..8641166 100644
--- a/gck/gck-session.c
+++ b/gck/gck-session.c
@@ -920,7 +920,7 @@ perform_init_pin (InitPin *args)
  * @pin: (nullable) (array length=n_pin): the user's PIN, or %NULL for
  *       protected authentication path
  * @n_pin: the length of the PIN
- * @cancellable: Optional cancellation object, or NULL.
+ * @cancellable: Optional cancellation object, or %NULL.
  * @error: A location to return an error.
  *
  * Initialize the user's pin on this slot that this session is opened on.
@@ -945,7 +945,7 @@ gck_session_init_pin (GckSession *self, const guchar *pin, gsize n_pin,
  * @self: Initialize PIN for this session's slot.
  * @pin: (nullable) (array length=n_pin): the user's PIN, or %NULL for protected authentication path
  * @n_pin: the length of the PIN
- * @cancellable: Optional cancellation object, or NULL.
+ * @cancellable: Optional cancellation object, or %NULL.
  * @callback: Called when the operation completes.
  * @user_data: Data to pass to the callback.
  *
@@ -1021,7 +1021,7 @@ perform_set_pin (SetPin *args)
  * @new_pin: (nullable) (array length=n_new_pin): the user's new PIN, or %NULL
  *           for protected authentication path
  * @n_new_pin: The length of the PIN.
- * @cancellable: Optional cancellation object, or NULL.
+ * @cancellable: Optional cancellation object, or %NULL.
  * @error: A location to return an error.
  *
  * Change the user's pin on this slot that this session is opened on.
@@ -1048,7 +1048,7 @@ gck_session_set_pin (GckSession *self, const guchar *old_pin, gsize n_old_pin,
  * @new_pin: (nullable) (array length=n_new_pin): the user's new PIN, or %NULL
  *           for protected authentication path
  * @n_new_pin: the length of the new PIN
- * @cancellable: Optional cancellation object, or NULL.
+ * @cancellable: Optional cancellation object, or %NULL.
  * @callback: Called when the operation completes.
  * @user_data: Data to pass to the callback.
  *
@@ -1120,7 +1120,7 @@ perform_login (Login *args)
  * @pin: (nullable) (array length=n_pin): the user's PIN, or %NULL for
  *       protected authentication path
  * @n_pin: The length of the PIN.
- * @cancellable: Optional cancellation object, or NULL.
+ * @cancellable: Optional cancellation object, or %NULL.
  * @error: A location to return an error.
  *
  * Login the user on the session. This call may block for
@@ -1144,7 +1144,7 @@ gck_session_login (GckSession *self, gulong user_type, const guchar *pin,
  * @pin: (nullable) (array length=n_pin): the user's PIN, or %NULL for
  *       protected authentication path
  * @n_pin: The length of the PIN.
- * @cancellable: Optional cancellation object, or NULL.
+ * @cancellable: Optional cancellation object, or %NULL.
  * @callback: Called when the operation completes.
  * @user_data: Data to pass to the callback.
  *
@@ -1306,7 +1306,7 @@ perform_logout (GckArguments *args)
 /**
  * gck_session_logout:
  * @self: Logout of this session.
- * @cancellable: Optional cancellation object, or NULL.
+ * @cancellable: Optional cancellation object, or %NULL.
  * @error: A location to return an error.
  *
  * Log out of the session. This call may block for an indefinite period.
@@ -1323,7 +1323,7 @@ gck_session_logout (GckSession *self, GCancellable *cancellable, GError **error)
 /**
  * gck_session_logout_async:
  * @self: Logout of this session.
- * @cancellable: Optional cancellation object, or NULL.
+ * @cancellable: Optional cancellation object, or %NULL.
  * @callback: Called when the operation completes.
  * @user_data: Data to pass to the callback.
  *
@@ -1400,8 +1400,8 @@ perform_create_object (CreateObject *args)
  * gck_session_create_object:
  * @self: The session to create the object on.
  * @attrs: The attributes to create the object with.
- * @cancellable: Optional cancellation object, or NULL.
- * @error: A location to return an error, or NULL.
+ * @cancellable: Optional cancellation object, or %NULL.
+ * @error: A location to return an error, or %NULL.
  *
  * Create a new PKCS\#11 object. This call may block for an
  * indefinite period.
@@ -1434,7 +1434,7 @@ gck_session_create_object (GckSession *self, GckAttributes *attrs,
  * gck_session_create_object_async:
  * @self: The session to create the object on.
  * @attrs: The attributes to create the object with.
- * @cancellable: Optional cancellation object or NULL.
+ * @cancellable: Optional cancellation object or %NULL.
  * @callback: Called when the operation completes.
  * @user_data: Data to pass to the callback.
  *
@@ -1462,11 +1462,11 @@ gck_session_create_object_async (GckSession *self, GckAttributes *attrs,
  * gck_session_create_object_finish:
  * @self: The session to create the object on.
  * @result: The result passed to the callback.
- * @error: A location to return an error, or NULL.
+ * @error: A location to return an error, or %NULL.
  *
  * Get the result of creating a new PKCS\#11 object.
  *
- * Return value: (transfer full): the newly created object or NULL if an error occurred
+ * Return value: (transfer full): the newly created object or %NULL if an error occurred
  **/
 GckObject *
 gck_session_create_object_finish (GckSession *self, GAsyncResult *result, GError **error)
@@ -1675,8 +1675,8 @@ gck_session_find_handles_finish (GckSession *self,
  * gck_session_find_objects:
  * @self: The session to find objects on.
  * @match: the attributes to match
- * @cancellable: Optional cancellation object or NULL.
- * @error: A location to return an error or NULL.
+ * @cancellable: Optional cancellation object or %NULL.
+ * @error: A location to return an error or %NULL.
  *
  * Find the objects matching the passed attributes. This call may
  * block for an indefinite period.
@@ -1714,7 +1714,7 @@ gck_session_find_objects (GckSession *self,
  * gck_session_find_objects_async:
  * @self: The session to find objects on.
  * @match: The attributes to match.
- * @cancellable: Optional cancellation object or NULL.
+ * @cancellable: Optional cancellation object or %NULL.
  * @callback: Called when the operation completes.
  * @user_data: Data to pass to the callback.
  *
@@ -1845,8 +1845,8 @@ perform_generate_key_pair (GenerateKeyPair *args)
  * @private_attrs: Additional attributes for the generated private key.
  * @public_key: (optional) (out): location to return the resulting public key
  * @private_key: (optional) (out): location to return the resulting private key.
- * @cancellable: Optional cancellation object, or NULL.
- * @error: A location to return an error, or NULL.
+ * @cancellable: Optional cancellation object, or %NULL.
+ * @error: A location to return an error, or %NULL.
  *
  * Generate a new key pair of public and private keys. This call may block for an
  * indefinite period.
@@ -1854,7 +1854,7 @@ perform_generate_key_pair (GenerateKeyPair *args)
  * If the @public_attrs and/or @private_attrs #GckAttributes is floating, it is
  * consumed.
  *
- * Return value: TRUE if the operation succeeded.
+ * Return value: %TRUE if the operation succeeded.
  **/
 gboolean
 gck_session_generate_key_pair (GckSession *self, gulong mech_type,
@@ -1874,8 +1874,8 @@ gck_session_generate_key_pair (GckSession *self, gulong mech_type,
  * @private_attrs: Additional attributes for the generated private key.
  * @public_key: (optional) (out): a location to return the resulting public key
  * @private_key: (optional) (out): a location to return the resulting private key
- * @cancellable: Optional cancellation object, or NULL.
- * @error: A location to return an error, or NULL.
+ * @cancellable: Optional cancellation object, or %NULL.
+ * @error: A location to return an error, or %NULL.
  *
  * Generate a new key pair of public and private keys. This call may block for an
  * indefinite period.
@@ -1883,7 +1883,7 @@ gck_session_generate_key_pair (GckSession *self, gulong mech_type,
  * If the @public_attrs and/or @private_attrs #GckAttributes is floating, it is
  * consumed.
  *
- * Return value: TRUE if the operation succeeded.
+ * Return value: %TRUE if the operation succeeded.
  **/
 gboolean
 gck_session_generate_key_pair_full (GckSession *self,
@@ -1930,7 +1930,7 @@ gck_session_generate_key_pair_full (GckSession *self,
  * @mechanism: The mechanism to use for key generation.
  * @public_attrs: Additional attributes for the generated public key.
  * @private_attrs: Additional attributes for the generated private key.
- * @cancellable: Optional cancellation object or NULL.
+ * @cancellable: Optional cancellation object or %NULL.
  * @callback: Called when the operation completes.
  * @user_data: Data to pass to the callback.
  *
@@ -1973,7 +1973,7 @@ gck_session_generate_key_pair_async (GckSession *self, GckMechanism *mechanism,
  *
  * Get the result of a generate key pair operation.
  *
- * Return value: TRUE if the operation succeeded.
+ * Return value: %TRUE if the operation succeeded.
  **/
 gboolean
 gck_session_generate_key_pair_finish (GckSession *self,
@@ -2051,7 +2051,7 @@ perform_wrap_key (WrapKey *args)
  * @wrapped: The key to wrap.
  * @n_result: A location in which to return the length of the wrapped data.
  * @cancellable: A #GCancellable or %NULL
- * @error: A location to return an error, or NULL.
+ * @error: A location to return an error, or %NULL.
  *
  * Wrap a key into a byte stream. This call may block for an
  * indefinite period.
@@ -2074,8 +2074,8 @@ gck_session_wrap_key (GckSession *self, GckObject *key, gulong mech_type,
  * @mechanism: The mechanism to use for wrapping.
  * @wrapped: The key to wrap.
  * @n_result: A location in which to return the length of the wrapped data.
- * @cancellable: Optional cancellation object, or NULL.
- * @error: A location to return an error, or NULL.
+ * @cancellable: Optional cancellation object, or %NULL.
+ * @error: A location to return an error, or %NULL.
  *
  * Wrap a key into a byte stream. This call may block for an
  * indefinite period.
@@ -2120,7 +2120,7 @@ gck_session_wrap_key_full (GckSession *self, GckObject *wrapper, GckMechanism *m
  * @wrapper: The key to use for wrapping.
  * @mechanism: The mechanism to use for wrapping.
  * @wrapped: The key to wrap.
- * @cancellable: Optional cancellation object or NULL.
+ * @cancellable: Optional cancellation object or %NULL.
  * @callback: Called when the operation completes.
  * @user_data: Data to pass to the callback.
  *
@@ -2232,15 +2232,15 @@ perform_unwrap_key (UnwrapKey *args)
  * @input: (array length=n_input): the wrapped data as a byte stream
  * @n_input: The length of the wrapped data.
  * @attrs: Additional attributes for the unwrapped key.
- * @cancellable: Optional cancellation object, or NULL.
- * @error: A location to return an error, or NULL.
+ * @cancellable: Optional cancellation object, or %NULL.
+ * @error: A location to return an error, or %NULL.
  *
  * Unwrap a key from a byte stream. This call may block for an
  * indefinite period.
  *
  * If the @attrs #GckAttributes is floating, it is consumed.
  *
- * Returns: (transfer full): the new unwrapped key or NULL if the
+ * Returns: (transfer full): the new unwrapped key or %NULL if the
  *          operation failed
  **/
 GckObject *
@@ -2265,15 +2265,15 @@ gck_session_unwrap_key (GckSession *self,
  * @input: (array length=n_input): the wrapped data as a byte stream
  * @n_input: The length of the wrapped data.
  * @attrs: Additional attributes for the unwrapped key.
- * @cancellable: Optional cancellation object, or NULL.
- * @error: A location to return an error, or NULL.
+ * @cancellable: Optional cancellation object, or %NULL.
+ * @error: A location to return an error, or %NULL.
  *
  * Unwrap a key from a byte stream. This call may block for an
  * indefinite period.
  *
  * If the @attrs #GckAttributes is floating, it is consumed.
  *
- * Returns: (transfer full): the new unwrapped key or NULL if the operation
+ * Returns: (transfer full): the new unwrapped key or %NULL if the operation
  *          failed
  **/
 GckObject *
@@ -2320,7 +2320,7 @@ gck_session_unwrap_key_full (GckSession *self,
  * @input: (array length=n_input): the wrapped data as a byte stream
  * @n_input: The length of the wrapped data.
  * @attrs: Additional attributes for the unwrapped key.
- * @cancellable: Optional cancellation object or NULL.
+ * @cancellable: Optional cancellation object or %NULL.
  * @callback: Called when the operation completes.
  * @user_data: Data to pass to the callback.
  *
@@ -2426,15 +2426,15 @@ perform_derive_key (DeriveKey *args)
  * @base: The key to derive from.
  * @mech_type: The mechanism to use for derivation.
  * @attrs: Additional attributes for the derived key.
- * @cancellable: Optional cancellation object, or NULL.
- * @error: A location to return an error, or NULL.
+ * @cancellable: Optional cancellation object, or %NULL.
+ * @error: A location to return an error, or %NULL.
  *
  * Derive a key from another key. This call may block for an
  * indefinite period.
  *
  * If the @attrs #GckAttributes is floating, it is consumed.
  *
- * Returns: (transfer full): the new derived key or NULL if the operation
+ * Returns: (transfer full): the new derived key or %NULL if the operation
  *          failed
  **/
 GckObject *
@@ -2451,15 +2451,15 @@ gck_session_derive_key (GckSession *self, GckObject *base, gulong mech_type,
  * @base: The key to derive from.
  * @mechanism: The mechanism to use for derivation.
  * @attrs: Additional attributes for the derived key.
- * @cancellable: Optional cancellation object, or NULL.
- * @error: A location to return an error, or NULL.
+ * @cancellable: Optional cancellation object, or %NULL.
+ * @error: A location to return an error, or %NULL.
  *
  * Derive a key from another key. This call may block for an
  * indefinite period.
  *
  * If the @attrs #GckAttributes is floating, it is consumed.
  *
- * Returns: (transfer full): the new derived key or NULL if the operation
+ * Returns: (transfer full): the new derived key or %NULL if the operation
  *          failed
  **/
 GckObject*
@@ -2498,7 +2498,7 @@ gck_session_derive_key_full (GckSession *self, GckObject *base, GckMechanism *me
  * @base: The key to derive from.
  * @mechanism: The mechanism to use for derivation.
  * @attrs: Additional attributes for the derived key.
- * @cancellable: Optional cancellation object or NULL.
+ * @cancellable: Optional cancellation object or %NULL.
  * @callback: Called when the operation completes.
  * @user_data: Data to pass to the callback.
  *
@@ -2864,7 +2864,7 @@ gck_session_encrypt_finish (GckSession *self, GAsyncResult *result, gsize *n_res
  * block for an indefinite period.
  *
  * Returns: (transfer full) (array length=n_result): the data that was decrypted,
- *          or NULL if an error occured
+ *          or %NULL if an error occured
  */
 guchar *
 gck_session_decrypt (GckSession *self, GckObject *key, gulong mech_type, const guchar *input,
@@ -2955,7 +2955,7 @@ gck_session_decrypt_async (GckSession *self, GckObject *key, GckMechanism *mecha
  * Get the result of an decryption operation.
  *
  * Returns: (transfer full) (array length=n_result): the data that was decrypted,
- *          or NULL if an error occurred
+ *          or %NULL if an error occurred
  */
 guchar*
 gck_session_decrypt_finish (GckSession *self, GAsyncResult *result,
@@ -3007,7 +3007,7 @@ gck_session_sign (GckSession *self, GckObject *key, gulong mech_type, const guch
  * Sign data in a mechanism specific manner. This call may
  * block for an indefinite period.
  *
- * Returns: The data that was signed, or NULL if an error occured.
+ * Returns: The data that was signed, or %NULL if an error occured.
  */
 guchar*
 gck_session_sign_full (GckSession *self, GckObject *key, GckMechanism *mechanism,
@@ -3160,7 +3160,7 @@ free_verify (Verify *args)
  * Verify data in a mechanism specific manner. This call may
  * block for an indefinite period.
  *
- * Returns: TRUE if the data verified correctly, otherwise a failure or error occurred.
+ * Returns: %TRUE if the data verified correctly, otherwise a failure or error occurred.
  */
 gboolean
 gck_session_verify (GckSession *self, GckObject *key, gulong mech_type, const guchar *input,
@@ -3186,7 +3186,7 @@ gck_session_verify (GckSession *self, GckObject *key, gulong mech_type, const gu
  * Verify data in a mechanism specific manner. This call may
  * block for an indefinite period.
  *
- * Returns: TRUE if the data verified correctly, otherwise a failure or error occurred.
+ * Returns: %TRUE if the data verified correctly, otherwise a failure or error occurred.
  */
 gboolean
 gck_session_verify_full (GckSession *self, GckObject *key, GckMechanism *mechanism,
@@ -3274,7 +3274,7 @@ gck_session_verify_async (GckSession *self, GckObject *key, GckMechanism *mechan
  *
  * Get the result of an verify operation.
  *
- * Returns: TRUE if the data verified correctly, otherwise a failure or error occurred.
+ * Returns: %TRUE if the data verified correctly, otherwise a failure or error occurred.
  */
 gboolean
 gck_session_verify_finish (GckSession *self, GAsyncResult *result, GError **error)
diff --git a/gck/gck-slot.c b/gck/gck-slot.c
index 6eb2a16..cb80f79 100644
--- a/gck/gck-slot.c
+++ b/gck/gck-slot.c
@@ -211,7 +211,7 @@ gck_slot_info_copy (GckSlotInfo *slot_info)
 
 /**
  * gck_slot_info_free:
- * @slot_info: The slot info to free, or NULL.
+ * @slot_info: The slot info to free, or %NULL.
  *
  * Free the GckSlotInfo and associated resources.
  **/
@@ -295,7 +295,7 @@ gck_token_info_copy (GckTokenInfo *token_info)
 
 /**
  * gck_token_info_free:
- * @token_info: The token info to free, or NULL.
+ * @token_info: The token info to free, or %NULL.
  *
  * Free the GckTokenInfo and associated resources.
  **/
@@ -355,7 +355,7 @@ gck_mechanism_info_copy (GckMechanismInfo *mech_info)
 
 /**
  * gck_mechanism_info_free:
- * @mech_info: The mechanism info to free, or NULL.
+ * @mech_info: The mechanism info to free, or %NULL.
  *
  * Free the GckMechanismInfo and associated resources.
  **/
@@ -453,7 +453,8 @@ gck_mechanisms_check (GArray *mechanisms, ...)
  * Checks equality of two slots. Two GckSlot objects can point to the same
  * underlying PKCS\#11 slot.
  *
- * Return value: TRUE if slot1 and slot2 are equal. FALSE if either is not a GckSlot.
+ * Return value: %TRUE if slot1 and slot2 are equal.
+ *               %FALSE if either is not a GckSlot.
  **/
 gboolean
 gck_slot_equal (gconstpointer slot1, gconstpointer slot2)
@@ -799,7 +800,7 @@ gck_slot_get_mechanisms (GckSlot *self)
  *
  * Get information for the specified mechanism.
  *
- * Returns: (transfer full): the mechanism information, or NULL if failed; use
+ * Returns: (transfer full): the mechanism information, or %NULL if failed; use
  *          gck_mechanism_info_free() when done with it
  **/
 GckMechanismInfo*
@@ -970,8 +971,8 @@ gck_slot_open_session (GckSlot *self,
  * @pkcs11_flags: Additional raw PKCS\#11 flags.
  * @app_data: Application data for notification callback.
  * @notify: PKCS\#11 notification callback.
- * @cancellable: Optional cancellation object, or NULL.
- * @error: A location to return an error, or NULL.
+ * @cancellable: Optional cancellation object, or %NULL.
+ * @error: A location to return an error, or %NULL.
  *
  * Open a session on the slot. If the 'auto reuse' setting is set,
  * then this may be a recycled session with the same flags.
@@ -1001,7 +1002,7 @@ gck_slot_open_session_full (GckSlot *self,
  * gck_slot_open_session_async:
  * @self: The slot to open a session on.
  * @options: The options to open the new session with.
- * @cancellable: Optional cancellation object, or NULL.
+ * @cancellable: Optional cancellation object, or %NULL.
  * @callback: Called when the operation completes.
  * @user_data: Data to pass to the callback.
  *
@@ -1046,7 +1047,7 @@ on_open_session_complete (GObject *source,
  * @pkcs11_flags: Additional raw PKCS\#11 flags.
  * @app_data: Application data for notification callback.
  * @notify: PKCS\#11 notification callback.
- * @cancellable: Optional cancellation object, or NULL.
+ * @cancellable: Optional cancellation object, or %NULL.
  * @callback: Called when the operation completes.
  * @user_data: Data to pass to the callback.
  *
@@ -1089,7 +1090,7 @@ gck_slot_open_session_full_async (GckSlot *self,
  * gck_slot_open_session_finish:
  * @self: The slot to open a session on.
  * @result: The result passed to the callback.
- * @error: A location to return an error or NULL.
+ * @error: A location to return an error or %NULL.
  *
  * Get the result of an open session operation. If the 'auto reuse' setting is set,
  * then this may be a recycled session with the same flags.
diff --git a/gcr/gcr-certificate-chain.c b/gcr/gcr-certificate-chain.c
index 72428da..8434df8 100644
--- a/gcr/gcr-certificate-chain.c
+++ b/gcr/gcr-certificate-chain.c
@@ -596,7 +596,7 @@ gcr_certificate_chain_get_status (GcrCertificateChain *self)
  * If an anchor is returned it does not mean that the certificate chain has
  * been verified, but merely that an anchor has been found.
  *
- * Returns: (transfer none): the anchor certificate, or NULL if not anchored.
+ * Returns: (transfer none): the anchor certificate, or %NULL if not anchored.
  */
 GcrCertificate *
 gcr_certificate_chain_get_anchor (GcrCertificateChain *self)
@@ -804,7 +804,7 @@ gcr_certificate_chain_build_async (GcrCertificateChain *self,
  * gcr_certificate_chain_build_finish:
  * @self: the #GcrCertificateChain
  * @result: the #GAsyncResult passed to the callback
- * @error: a #GError, or NULL
+ * @error: a #GError, or %NULL
  *
  * Finishes an asynchronous operation started by
  * gcr_certificate_chain_build_async().
diff --git a/gcr/gcr-certificate.c b/gcr/gcr-certificate.c
index d44475d..d8e31a8 100644
--- a/gcr/gcr-certificate.c
+++ b/gcr/gcr-certificate.c
@@ -428,7 +428,7 @@ gcr_certificate_get_der_data (GcrCertificate *self,
  * This will try to lookup the common name, orianizational unit,
  * organization in that order.
  *
- * Returns: the allocated issuer name, or NULL if no issuer name
+ * Returns: the allocated issuer name, or %NULL if no issuer name
  */
 gchar *
 gcr_certificate_get_issuer_name (GcrCertificate *self)
@@ -453,7 +453,7 @@ gcr_certificate_get_issuer_name (GcrCertificate *self)
  * The string returned should be freed by the caller when no longer
  * required.
  *
- * Returns: The allocated issuer CN, or NULL if no issuer CN present.
+ * Returns: The allocated issuer CN, or %NULL if no issuer CN present.
  */
 gchar*
 gcr_certificate_get_issuer_cn (GcrCertificate *self)
@@ -613,7 +613,7 @@ gcr_certificate_get_issuer_dn (GcrCertificate *self)
  * The string returned should be freed by the caller when no longer
  * required.
  *
- * Returns: The allocated subject CN, or NULL if no subject CN present.
+ * Returns: The allocated subject CN, or %NULL if no subject CN present.
  */
 gchar*
 gcr_certificate_get_subject_cn (GcrCertificate *self)
@@ -630,7 +630,7 @@ gcr_certificate_get_subject_cn (GcrCertificate *self)
  * This will try to lookup the common name, orianizational unit,
  * organization in that order.
  *
- * Returns: the allocated subject name, or NULL if no subject name
+ * Returns: the allocated subject name, or %NULL if no subject name
  */
 gchar *
 gcr_certificate_get_subject_name (GcrCertificate *self)
diff --git a/gcr/gcr-gnupg-key.c b/gcr/gcr-gnupg-key.c
index 55836fc..f25267b 100644
--- a/gcr/gcr-gnupg-key.c
+++ b/gcr/gcr-gnupg-key.c
@@ -419,7 +419,7 @@ _gcr_gnupg_key_get_icon (GcrGnupgKey *self)
  *
  * Get the columns that we should display for gnupg keys.
  *
- * Returns: (transfer none): The columns, NULL terminated, should not be freed.
+ * Returns: (transfer none): The columns, %NULL terminated, should not be freed.
  */
 const GcrColumn*
 _gcr_gnupg_key_get_columns (void)
diff --git a/gcr/gcr-library.c b/gcr/gcr-library.c
index df9e807..bbce13f 100644
--- a/gcr/gcr-library.c
+++ b/gcr/gcr-library.c
@@ -438,7 +438,7 @@ gcr_pkcs11_add_module (GckModule *module)
  * gcr_pkcs11_add_module_from_file:
  * @module_path: the full file path of the PKCS\#11 module
  * @unused: unused
- * @error: a #GError or NULL
+ * @error: a #GError or %NULL
  *
  * Initialize a PKCS\#11 module and add it to the modules that are
  * used by the GCR library. Note that is an error to initialize the same
diff --git a/gcr/gcr-pkcs11-certificate.c b/gcr/gcr-pkcs11-certificate.c
index 8016c89..efd1de8 100644
--- a/gcr/gcr-pkcs11-certificate.c
+++ b/gcr/gcr-pkcs11-certificate.c
@@ -339,7 +339,7 @@ gcr_pkcs11_certificate_get_attributes (GcrPkcs11Certificate *self)
  * gcr_pkcs11_certificate_lookup_issuer:
  * @certificate: a #GcrCertificate
  * @cancellable: a #GCancellable
- * @error: a #GError, or NULL
+ * @error: a #GError, or %NULL
  *
  * Lookup a the issuer of a @certificate in the PKCS\#11 storage. The
  * lookup is done using the issuer DN of the certificate. No certificate chain
@@ -414,7 +414,7 @@ gcr_pkcs11_certificate_lookup_issuer_async (GcrCertificate *certificate, GCancel
 /**
  * gcr_pkcs11_certificate_lookup_issuer_finish:
  * @result: the #GAsyncResult passed to the callback
- * @error: a #GError, or NULL
+ * @error: a #GError, or %NULL
  *
  * Finishes an asynchronous operation started by
  * gcr_pkcs11_certificate_lookup_issuer_async().
diff --git a/gcr/gcr-trust.c b/gcr/gcr-trust.c
index 4c20c7d..2a74b59 100644
--- a/gcr/gcr-trust.c
+++ b/gcr/gcr-trust.c
@@ -177,7 +177,7 @@ perform_is_certificate_pinned (GckAttributes *search,
  * @purpose: the purpose string
  * @peer: the peer for this pinned
  * @cancellable: a #GCancellable
- * @error: a #GError, or NULL
+ * @error: a #GError, or %NULL
  *
  * Check if @certificate is pinned for @purpose to communicate with @peer.
  * A pinned certificate overrides all other certificate verification.
@@ -269,7 +269,7 @@ gcr_trust_is_certificate_pinned_async (GcrCertificate *certificate, const gchar
 /**
  * gcr_trust_is_certificate_pinned_finish:
  * @result: the #GAsyncResult passed to the callback
- * @error: a #GError, or NULL
+ * @error: a #GError, or %NULL
  *
  * Finishes an asynchronous operation started by
  * gcr_trust_is_certificate_pinned_async().
@@ -393,7 +393,7 @@ perform_add_pinned_certificate (GckAttributes *search,
  * @purpose: the purpose string
  * @peer: the peer for this pinned certificate
  * @cancellable: a #GCancellable
- * @error: a #GError, or NULL
+ * @error: a #GError, or %NULL
  *
  * Add a pinned @certificate for connections to @peer for @purpose. A pinned
  * certificate overrides all other certificate verification and should be
@@ -490,7 +490,7 @@ gcr_trust_add_pinned_certificate_async (GcrCertificate *certificate, const gchar
 /**
  * gcr_trust_add_pinned_certificate_finish:
  * @result: the #GAsyncResult passed to the callback
- * @error: a #GError, or NULL
+ * @error: a #GError, or %NULL
  *
  * Finishes an asynchronous operation started by
  * gcr_trust_add_pinned_certificate_async().
@@ -580,7 +580,7 @@ perform_remove_pinned_certificate (GckAttributes *attrs,
  * @purpose: the purpose string
  * @peer: the peer for this pinned certificate
  * @cancellable: a #GCancellable
- * @error: a #GError, or NULL
+ * @error: a #GError, or %NULL
  *
  * Remove a pinned certificate for communication with @peer for @purpose.
  *
@@ -673,7 +673,7 @@ gcr_trust_remove_pinned_certificate_async (GcrCertificate *certificate, const gc
 /**
  * gcr_trust_remove_pinned_certificate_finish:
  * @result: the #GAsyncResult passed to the callback
- * @error: a #GError, or NULL
+ * @error: a #GError, or %NULL
  *
  * Finishes an asynchronous operation started by
  * gcr_trust_remove_pinned_certificate_async().
@@ -743,7 +743,7 @@ perform_is_certificate_anchored (GckAttributes *attrs,
  * @certificate: a #GcrCertificate to check
  * @purpose: the purpose string
  * @cancellable: a #GCancellable
- * @error: a #GError, or NULL
+ * @error: a #GError, or %NULL
  *
  * Check if the @certificate is a trust anchor for the given @purpose. A trust
  * anchor is used to verify the signatures on other certificates when verifying
@@ -833,7 +833,7 @@ gcr_trust_is_certificate_anchored_async (GcrCertificate *certificate, const gcha
 /**
  * gcr_trust_is_certificate_anchored_finish:
  * @result: the #GAsyncResult passed to the callback
- * @error: a #GError, or NULL
+ * @error: a #GError, or %NULL
  *
  * Finishes an asynchronous operation started by
  * gcr_trust_is_certificate_anchored_async().
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]