[unique] Annotate unique_message_data_[sg]et_uris()



commit adf6a995e2804f5f6e23556d48e2f32e77bde5eb
Author: Emmanuele Bassi <ebassi gnome org>
Date:   Fri Nov 6 13:19:41 2009 +0000

    Annotate unique_message_data_[sg]et_uris()
    
    The fact that the URI array is NULL-terminated should be made clear,
    in the documentation and the introspection annotations.
    
    Thanks to: Stephane Delcroix <stephane delcroix org>

 unique/uniquemessage.c |    7 ++++---
 1 files changed, 4 insertions(+), 3 deletions(-)
---
diff --git a/unique/uniquemessage.c b/unique/uniquemessage.c
index 6cb6269..10f6df5 100644
--- a/unique/uniquemessage.c
+++ b/unique/uniquemessage.c
@@ -386,7 +386,8 @@ unique_message_data_get_text (UniqueMessageData *message_data)
 /**
  * unique_message_data_set_uris:
  * @message_data: a #UniqueMessageData
- * @uris: a list of URIs in a string vector
+ * @uris: (array zero-terminated=1) (element-type utf8): a list of URIs
+ *   in a %NULL-terminated string vector
  *
  * Converts @uris to a valid URI list and sets it as payload of
  * @message_data. You can use unique_message_data_get_uris() to
@@ -430,10 +431,10 @@ unique_message_data_set_uris (UniqueMessageData  *message_data,
  * unique_message_data_get_uris:
  * @message_data: a #UniqueMessageData
  *
- * Retrieves a string vector containing the URIs set with
+ * Retrieves a %NULL-terminated string vector containing the URIs set with
  * unique_message_data_set_uris().
  *
- * Return value: an allocated list of URIs. Use g_strfreev() to free it.
+ * Return value: (array zero-terminated=1) (element-type utf8) (transfer full): an allocated list of URIs. Use g_strfreev() to free it.
  */
 gchar **
 unique_message_data_get_uris (UniqueMessageData *message_data)



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]