summaryrefslogtreecommitdiff
path: root/cogl/cogl-object.h
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@linux.intel.com>2010-12-22 09:42:41 +0000
committerEmmanuele Bassi <ebassi@linux.intel.com>2010-12-22 09:52:35 +0000
commitaa4f63338c3fe5dab521d32671cde1bbd11188c5 (patch)
treeb07143d51f4664d8b784b914280a49841d926387 /cogl/cogl-object.h
parentba4e3905d32c7bdeca889d87036ed64ce4f7f4eb (diff)
downloadcogl-aa4f63338c3fe5dab521d32671cde1bbd11188c5.tar.gz
docs: Fixes for the Cogl API reference
Diffstat (limited to 'cogl/cogl-object.h')
-rw-r--r--cogl/cogl-object.h19
1 files changed, 10 insertions, 9 deletions
diff --git a/cogl/cogl-object.h b/cogl/cogl-object.h
index adb525e8..71dd8bd7 100644
--- a/cogl/cogl-object.h
+++ b/cogl/cogl-object.h
@@ -82,15 +82,15 @@ typedef struct
typedef void (*CoglUserDataDestroyCallback) (void *user_data);
/**
- * cogl_object_set_user_data:
+ * cogl_object_set_user_data: (skip)
* @object: The object to associate private data with
* @key: The address of a #CoglUserDataKey which provides a unique value
- * with which to index the private data.
- * @user_data: The data to associate with the given object, or NULL to
- * remove a previous association.
+ * with which to index the private data.
+ * @user_data: The data to associate with the given object,
+ * or %NULL to remove a previous association.
* @destroy: A #CoglUserDataDestroyCallback to call if the object is
- * destroyed or if the association is removed by later setting
- * NULL data for the same key.
+ * destroyed or if the association is removed by later setting
+ * %NULL data for the same key.
*
* Associates some private @user_data with a given #CoglObject. To
* later remove the association call cogl_object_set_user_data() with
@@ -105,7 +105,7 @@ cogl_object_set_user_data (CoglObject *object,
CoglUserDataDestroyCallback destroy);
/**
- * cogl_object_get_user_data:
+ * cogl_object_get_user_data: (skip)
* @object: The object with associated private data to query
* @key: The address of a #CoglUserDataKey which provides a unique value
* with which to index the private data.
@@ -114,8 +114,9 @@ cogl_object_set_user_data (CoglObject *object,
* the given @key. If no user data has been associated with @object
* for the given @key this function returns NULL.
*
- * Returns: The user data previously associated with @object using
- * the given @key; or NULL if no associated data is found.
+ * Returns: (transfer none): The user data previously associated
+ * with @object using the given @key; or %NULL if no associated
+ * data is found.
*
* Since: 1.4
*/