[libgsf] Introspection: doc fixes.
- From: Morten Welinder <mortenw src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libgsf] Introspection: doc fixes.
- Date: Fri, 8 Mar 2013 00:48:04 +0000 (UTC)
commit 09f5ecb98fd6ff4f05837714521fe337b63810ad
Author: Morten Welinder <terra gnome org>
Date: Thu Mar 7 19:47:49 2013 -0500
Introspection: doc fixes.
gsf/gsf-blob.c | 14 ++++++++------
gsf/gsf-doc-meta-data.c | 19 +++++++++----------
2 files changed, 17 insertions(+), 16 deletions(-)
---
diff --git a/gsf/gsf-blob.c b/gsf/gsf-blob.c
index 7a6c641..aeaebf9 100644
--- a/gsf/gsf-blob.c
+++ b/gsf/gsf-blob.c
@@ -77,7 +77,8 @@ GSF_CLASS (GsfBlob, gsf_blob,
/**
* gsf_blob_new:
* @size: Size of the data in bytes.
- * @data_to_copy: Data which will be copied into the blob, or %NULL if @size is zero.
+ * @data_to_copy: (in) (array length=size) (element-type guint8):
+ * Data which will be copied into the blob, or %NULL if @size is zero.
* @error: location to store error, or %NULL.
*
* Creates a new #GsfBlob object to hold the specified data. The blob can then
@@ -153,12 +154,13 @@ gsf_blob_get_size (GsfBlob const *blob)
* gsf_blob_peek_data:
* @blob: A #GsfBlob.
*
- * Queries a pointer to the data stored in the blob. This does not copy the data
- * for you; it returns a pointer to the actual buffer which the blob uses internally,
- * so you should not free this buffer on your own.
+ * Queries a pointer to the data stored in the blob. This does not
+ * copy the data for you; it returns a pointer to the actual buffer
+ * which the blob uses internally, so you should not free this buffer
+ * on your own.
*
- * Return value: (transfer none): Pointer to the data stored in the blob, or %NULL if the size
- * of the data is zero.
+ * Return value: (transfer none): Pointer to the data stored in the
+ * blob, or %NULL if the size of the data is zero.
**/
gconstpointer
gsf_blob_peek_data (GsfBlob const *blob)
diff --git a/gsf/gsf-doc-meta-data.c b/gsf/gsf-doc-meta-data.c
index c844523..46d0d97 100644
--- a/gsf/gsf-doc-meta-data.c
+++ b/gsf/gsf-doc-meta-data.c
@@ -264,13 +264,12 @@ gsf_doc_meta_dump (GsfDocMetaData const *meta)
/**
* gsf_doc_prop_new:
- * @name:
+ * @name: (transfer full): The name of the property.
*
- * Returns: a new #GsfDocProp which the caller is responsible for freeing.
- * Takes ownership of @name.
+ * Returns: (transfer full): a new #GsfDocProp.
**/
GsfDocProp *
-gsf_doc_prop_new (char *name)
+gsf_doc_prop_new (char *name)
{
GsfDocProp *prop;
@@ -286,7 +285,7 @@ gsf_doc_prop_new (char *name)
/**
* gsf_doc_prop_free:
- * @prop: #GsfDocProp
+ * @prop: (allow-none): #GsfDocProp
*
* If @prop is non %NULL free the memory associated with it
**/
@@ -359,7 +358,7 @@ gsf_doc_prop_get_val (GsfDocProp const *prop)
/**
* gsf_doc_prop_set_val:
* @prop: #GsfDocProp
- * @val: #GValue
+ * @val: (transfer full): #GValue
*
* Assigns @val to @prop, and unsets and frees the current value.
**/
@@ -380,10 +379,10 @@ gsf_doc_prop_set_val (GsfDocProp *prop, GValue *val)
/**
* gsf_doc_prop_swap_val:
* @prop: #GsfDocProp
- * @val: #GValue
+ * @val: (transfer full): #GValue
*
- * Returns: the current value of @prop, and replaces it with @val
- * Caller is responsible for unsetting and freeing the result.
+ * Returns: (transfer full): the current value of @prop, and replaces
+ * it with @val.
**/
GValue *
gsf_doc_prop_swap_val (GsfDocProp *prop, GValue *val)
@@ -412,7 +411,7 @@ gsf_doc_prop_get_link (GsfDocProp const *prop)
/**
* gsf_doc_prop_set_link:
* @prop: #GsfDocProp
- * @link: optionally %NULL
+ * @link: (transfer full): optionally %NULL
*
* Sets @prop's link to @link
**/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]