[libgdata] [introspection] Add (element-type) annotations

From: Philip Withnall <pwithnall src gnome org>
To: commits-list gnome org
Cc:
Subject: [libgdata] [introspection] Add (element-type) annotations
Date: Fri, 16 Jul 2010 09:10:08 +0000 (UTC)
commit 5f1b98340f5050a9f4e3ae402bb6b45e52e7c582
Author: Philip Withnall <philip tecnocode co uk>
Date:   Fri Jul 16 10:09:34 2010 +0100

    [introspection] Add (element-type) annotations

 gdata/app/gdata-app-categories.c                 |    2 +-
 gdata/gd/gdata-gd-when.c                         |    2 +-
 gdata/gdata-entry.c                              |    7 +++--
 gdata/gdata-feed.c                               |    8 +++---
 gdata/media/gdata-media-group.c                  |    4 +-
 gdata/services/calendar/gdata-calendar-event.c   |    6 ++--
 gdata/services/contacts/gdata-contacts-contact.c |   28 +++++++++++-----------
 gdata/services/documents/gdata-documents-query.c |    6 +++-
 gdata/services/picasaweb/gdata-picasaweb-album.c |    4 +-
 gdata/services/picasaweb/gdata-picasaweb-file.c  |    4 +-
 gdata/services/youtube/gdata-youtube-video.c     |    2 +-
 11 files changed, 38 insertions(+), 35 deletions(-)
---
diff --git a/gdata/app/gdata-app-categories.c b/gdata/app/gdata-app-categories.c
index 2c70485..44a2409 100644
--- a/gdata/app/gdata-app-categories.c
+++ b/gdata/app/gdata-app-categories.c
@@ -201,7 +201,7 @@ post_parse_xml (GDataParsable *parsable, gpointer user_data, GError **error)
  *
  * Returns a list of the categories in this category list.
  *
- * Return value: a #GList of #GDataCategory<!-- -->s
+ * Return value: (element-type GData.Category) (transfer none): a #GList of #GDataCategory<!-- -->s
  *
  * Since: 0.7.0
  **/
diff --git a/gdata/gd/gdata-gd-when.c b/gdata/gd/gdata-gd-when.c
index 85f729c..bf3babb 100644
--- a/gdata/gd/gdata-gd-when.c
+++ b/gdata/gd/gdata-gd-when.c
@@ -562,7 +562,7 @@ gdata_gd_when_set_value_string (GDataGDWhen *self, const gchar *value_string)
  *
  * Returns a list of the #GDataGDReminder<!-- -->s which are associated with this #GDataGDWhen.
  *
- * Return value: a #GList of #GDataGDReminder<!-- -->s, or %NULL
+ * Return value: (element-type GData.GDReminder) (transfer none): a #GList of #GDataGDReminder<!-- -->s, or %NULL
  *
  * Since: 0.4.0
  **/
diff --git a/gdata/gdata-entry.c b/gdata/gdata-entry.c
index 5b085e8..29a4eae 100644
--- a/gdata/gdata-entry.c
+++ b/gdata/gdata-entry.c
@@ -750,7 +750,7 @@ gdata_entry_add_category (GDataEntry *self, GDataCategory *category)
  *
  * Gets a list of the #GDataCategory<!-- -->s containing this entry.
  *
- * Return value: a #GList of #GDataCategory<!-- -->s
+ * Return value: (element-type GData.Category) (transfer none): a #GList of #GDataCategory<!-- -->s
  *
  * Since: 0.2.0
  **/
@@ -767,7 +767,7 @@ gdata_entry_get_categories (GDataEntry *self)
  *
  * Gets a list of the #GDataAuthor<!-- -->s for this entry.
  *
- * Return value: a #GList of #GDataAuthor<!-- -->s
+ * Return value: (element-type GData.Author) (transfer none): a #GList of #GDataAuthor<!-- -->s
  *
  * Since: 0.7.0
  **/
@@ -874,7 +874,8 @@ gdata_entry_look_up_link (GDataEntry *self, const gchar *rel)
  *
  * If you will only use the first link found, consider calling gdata_entry_look_up_link() instead.
  *
- * Return value: a #GList of #GDataLink<!-- -->s, or %NULL if none were found; free the list with g_list_free()
+ * Return value: (element-type GData.Link) (transfer container): a #GList of #GDataLink<!-- -->s, or %NULL if none were found; free the list with
+ * g_list_free()
  *
  * Since: 0.4.0
  **/
diff --git a/gdata/gdata-feed.c b/gdata/gdata-feed.c
index 0a19794..d2c86c2 100644
--- a/gdata/gdata-feed.c
+++ b/gdata/gdata-feed.c
@@ -631,7 +631,7 @@ _gdata_feed_new_from_xml (GType feed_type, const gchar *xml, gint length, GType
  *
  * Returns a list of the entries contained in this feed.
  *
- * Return value: a #GList of #GDataEntry<!-- -->s
+ * Return value: (element-type GData.Entry) (transfer none): a #GList of #GDataEntry<!-- -->s
  **/
 GList *
 gdata_feed_get_entries (GDataFeed *self)
@@ -677,7 +677,7 @@ gdata_feed_look_up_entry (GDataFeed *self, const gchar *id)
  *
  * Returns a list of the categories listed in this feed.
  *
- * Return value: a #GList of #GDataCategory<!-- -->s
+ * Return value: (element-type GData.Category) (transfer none): a #GList of #GDataCategory<!-- -->s
  **/
 GList *
 gdata_feed_get_categories (GDataFeed *self)
@@ -698,7 +698,7 @@ _gdata_feed_add_category (GDataFeed *self, GDataCategory *category)
  *
  * Returns a list of the links listed in this feed.
  *
- * Return value: a #GList of #GDataLink<!-- -->s
+ * Return value: (element-type GData.Link) (transfer none): a #GList of #GDataLink<!-- -->s
  **/
 GList *
 gdata_feed_get_links (GDataFeed *self)
@@ -750,7 +750,7 @@ _gdata_feed_add_link (GDataFeed *self, GDataLink *_link)
  *
  * Returns a list of the authors listed in this feed.
  *
- * Return value: a #GList of #GDataAuthor<!-- -->s
+ * Return value: (element-type GData.Author) (transfer none): a #GList of #GDataAuthor<!-- -->s
  **/
 GList *
 gdata_feed_get_authors (GDataFeed *self)
diff --git a/gdata/media/gdata-media-group.c b/gdata/media/gdata-media-group.c
index e9566f2..1c5d2a1 100644
--- a/gdata/media/gdata-media-group.c
+++ b/gdata/media/gdata-media-group.c
@@ -486,7 +486,7 @@ gdata_media_group_look_up_content (GDataMediaGroup *self, const gchar *type)
  *
  * Returns a list of #GDataMediaContent<!-- -->s, giving the content enclosed by the group.
  *
- * Return value: a #GList of #GDataMediaContent<!-- -->s,  or %NULL
+ * Return value: (element-type GData.MediaContent) (transfer none): a #GList of #GDataMediaContent<!-- -->s,  or %NULL
  **/
 GList *
 gdata_media_group_get_contents (GDataMediaGroup *self)
@@ -572,7 +572,7 @@ gdata_media_group_is_restricted_in_country (GDataMediaGroup *self, const gchar *
  *
  * Gets a list of the thumbnails available for the group.
  *
- * Return value: a #GList of #GDataMediaThumbnail<!-- -->s, or %NULL
+ * Return value: (element-type GData.MediaThumbnail) (transfer none): a #GList of #GDataMediaThumbnail<!-- -->s, or %NULL
  **/
 GList *
 gdata_media_group_get_thumbnails (GDataMediaGroup *self)
diff --git a/gdata/services/calendar/gdata-calendar-event.c b/gdata/services/calendar/gdata-calendar-event.c
index ff5ed79..d360fab 100644
--- a/gdata/services/calendar/gdata-calendar-event.c
+++ b/gdata/services/calendar/gdata-calendar-event.c
@@ -991,7 +991,7 @@ gdata_calendar_event_add_person (GDataCalendarEvent *self, GDataGDWho *who)
  *
  * Gets a list of the people attending the event.
  *
- * Return value: a #GList of #GDataGDWho<!-- -->s, or %NULL
+ * Return value: (element-type GData.GDWho) (transfer none): a #GList of #GDataGDWho<!-- -->s, or %NULL
  *
  * Since: 0.2.0
  **/
@@ -1027,7 +1027,7 @@ gdata_calendar_event_add_place (GDataCalendarEvent *self, GDataGDWhere *where)
  *
  * Gets a list of the locations associated with the event.
  *
- * Return value: a #GList of #GDataGDWhere<!-- -->s, or %NULL
+ * Return value: (element-type GData.GDWhere) (transfer none): a #GList of #GDataGDWhere<!-- -->s, or %NULL
  *
  * Since: 0.2.0
  **/
@@ -1065,7 +1065,7 @@ gdata_calendar_event_add_time (GDataCalendarEvent *self, GDataGDWhen *when)
  *
  * Gets a list of the time periods associated with the event.
  *
- * Return value: a #GList of #GDataGDWhen<!-- -->s, or %NULL
+ * Return value: (element-type GData.GDWhen) (transfer none): a #GList of #GDataGDWhen<!-- -->s, or %NULL
  *
  * Since: 0.2.0
  **/
diff --git a/gdata/services/contacts/gdata-contacts-contact.c b/gdata/services/contacts/gdata-contacts-contact.c
index da51b50..f81f73e 100644
--- a/gdata/services/contacts/gdata-contacts-contact.c
+++ b/gdata/services/contacts/gdata-contacts-contact.c
@@ -1659,7 +1659,7 @@ gdata_contacts_contact_add_email_address (GDataContactsContact *self, GDataGDEma
  *
  * Gets a list of the e-mail addresses owned by the contact.
  *
- * Return value: a #GList of #GDataGDEmailAddress<!-- -->es, or %NULL
+ * Return value: (element-type GData.GDEMailAddress) (transfer none): a #GList of #GDataGDEmailAddress<!-- -->es, or %NULL
  *
  * Since: 0.2.0
  **/
@@ -1748,7 +1748,7 @@ gdata_contacts_contact_add_im_address (GDataContactsContact *self, GDataGDIMAddr
  *
  * Gets a list of the IM addresses owned by the contact.
  *
- * Return value: a #GList of #GDataGDIMAddress<!-- -->es, or %NULL
+ * Return value: (element-type GData.GDIMAddress) (transfer none): a #GList of #GDataGDIMAddress<!-- -->es, or %NULL
  *
  * Since: 0.2.0
  **/
@@ -1837,7 +1837,7 @@ gdata_contacts_contact_add_phone_number (GDataContactsContact *self, GDataGDPhon
  *
  * Gets a list of the phone numbers owned by the contact.
  *
- * Return value: a #GList of #GDataGDPhoneNumber<!-- -->s, or %NULL
+ * Return value: (element-type GData.GDPhoneNumber) (transfer none): a #GList of #GDataGDPhoneNumber<!-- -->s, or %NULL
  *
  * Since: 0.2.0
  **/
@@ -1926,7 +1926,7 @@ gdata_contacts_contact_add_postal_address (GDataContactsContact *self, GDataGDPo
  *
  * Gets a list of the postal addresses owned by the contact.
  *
- * Return value: a #GList of #GDataGDPostalAddress<!-- -->es, or %NULL
+ * Return value: (element-type GData.GDPostalAddress) (transfer none): a #GList of #GDataGDPostalAddress<!-- -->es, or %NULL
  *
  * Since: 0.2.0
  **/
@@ -2015,7 +2015,7 @@ gdata_contacts_contact_add_organization (GDataContactsContact *self, GDataGDOrga
  *
  * Gets a list of the organizations to which the contact belongs.
  *
- * Return value: a #GList of #GDataGDOrganization<!-- -->s, or %NULL
+ * Return value: (element-type GData.GDOrganization) (transfer none): a #GList of #GDataGDOrganization<!-- -->s, or %NULL
  *
  * Since: 0.2.0
  **/
@@ -2099,7 +2099,7 @@ gdata_contacts_contact_add_jot (GDataContactsContact *self, GDataGContactJot *jo
  *
  * Gets a list of the jots attached to the contact.
  *
- * Return value: a #GList of #GDataGContactJot<!-- -->s, or %NULL
+ * Return value: (element-type GData.GContactJot) (transfer none): a #GList of #GDataGContactJot<!-- -->s, or %NULL
  *
  * Since: 0.7.0
  **/
@@ -2159,7 +2159,7 @@ gdata_contacts_contact_add_relation (GDataContactsContact *self, GDataGContactRe
  *
  * Gets a list of the relations of the contact.
  *
- * Return value: a #GList of #GDataGContactRelation<!-- -->s, or %NULL
+ * Return value: (element-type GData.GContactRelation) (transfer none): a #GList of #GDataGContactRelation<!-- -->s, or %NULL
  *
  * Since: 0.7.0
  **/
@@ -2220,7 +2220,7 @@ gdata_contacts_contact_add_website (GDataContactsContact *self, GDataGContactWeb
  *
  * Gets a list of the websites of the contact.
  *
- * Return value: a #GList of #GDataGContactWebsite<!-- -->s, or %NULL
+ * Return value: (element-type GData.GContactWebsite) (transfer none): a #GList of #GDataGContactWebsite<!-- -->s, or %NULL
  *
  * Since: 0.7.0
  **/
@@ -2305,7 +2305,7 @@ gdata_contacts_contact_add_event (GDataContactsContact *self, GDataGContactEvent
  *
  * Gets a list of the events of the contact.
  *
- * Return value: a #GList of #GDataGContactEvent<!-- -->s, or %NULL
+ * Return value: (element-type GData.GContactEvent) (transfer none): a #GList of #GDataGContactEvent<!-- -->s, or %NULL
  *
  * Since: 0.7.0
  **/
@@ -2366,7 +2366,7 @@ gdata_contacts_contact_add_calendar (GDataContactsContact *self, GDataGContactCa
  *
  * Gets a list of the calendars of the contact.
  *
- * Return value: a #GList of #GDataGContactCalendar<!-- -->s, or %NULL
+ * Return value: (element-type GData.GContactCalendar) (transfer none): a #GList of #GDataGContactCalendar<!-- -->s, or %NULL
  *
  * Since: 0.7.0
  **/
@@ -2451,7 +2451,7 @@ gdata_contacts_contact_add_external_id (GDataContactsContact *self, GDataGContac
  *
  * Gets a list of the external IDs of the contact.
  *
- * Return value: a #GList of #GDataGContactExternalID<!-- -->s, or %NULL
+ * Return value: (element-type GData.GContactExternalID) (transfer none): a #GList of #GDataGContactExternalID<!-- -->s, or %NULL
  *
  * Since: 0.7.0
  **/
@@ -2511,7 +2511,7 @@ gdata_contacts_contact_add_hobby (GDataContactsContact *self, const gchar *hobby
  *
  * Gets a list of the hobbies of the contact.
  *
- * Return value: a #GList of hobby strings, or %NULL
+ * Return value: (element-type utf8) (transfer none): a #GList of hobby strings, or %NULL
  *
  * Since: 0.7.0
  **/
@@ -2571,7 +2571,7 @@ gdata_contacts_contact_add_language (GDataContactsContact *self, GDataGContactLa
  *
  * Gets a list of the languages of the contact.
  *
- * Return value: a #GList of #GDataGContactLanguage<!-- -->s, or %NULL
+ * Return value: (element-type GData.GContactLanguage) (transfer none): a #GList of #GDataGContactLanguage<!-- -->s, or %NULL
  *
  * Since: 0.7.0
  **/
@@ -2818,7 +2818,7 @@ get_groups_cb (const gchar *href, gpointer deleted, GList **groups)
  *
  * Gets a list of the groups to which the contact belongs.
  *
- * Return value: a #GList of constant group ID URIs, or %NULL; free with g_list_free()
+ * Return value: (element-type utf8) (transfer container): a #GList of constant group ID URIs, or %NULL; free with g_list_free()
  *
  * Since: 0.2.0
  **/
diff --git a/gdata/services/documents/gdata-documents-query.c b/gdata/services/documents/gdata-documents-query.c
index 042a272..1e10821 100644
--- a/gdata/services/documents/gdata-documents-query.c
+++ b/gdata/services/documents/gdata-documents-query.c
@@ -511,7 +511,8 @@ gdata_documents_query_set_title (GDataDocumentsQuery *self, const gchar *title,
  *
  * Gets a list of #GDataGDEmailAddress<!-- -->es of the document collaborators whose documents will be queried.
  *
- * Return value: a list of #GDataGDEmailAddress<!-- -->es of the collaborators concerned by the query, or %NULL
+ * Return value: (element-type GData.GDEmailAddress) (transfer none): a list of #GDataGDEmailAddress<!-- -->es of the collaborators concerned by the
+ * query, or %NULL
  *
  * Since: 0.4.0
  **/
@@ -528,7 +529,8 @@ gdata_documents_query_get_collaborator_addresses (GDataDocumentsQuery *self)
  *
  * Gets a list of #GDataGDEmailAddress<!-- -->es of the document readers whose documents will be queried.
  *
- * Return value: a list of #GDataGDEmailAddress<!-- -->es of the readers concerned by the query, or %NULL
+ * Return value: (element-type GData.GDEmailAddress) (transfer none): a list of #GDataGDEmailAddress<!-- -->es of the readers concerned by the query,
+ * or %NULL
  *
  * Since: 0.4.0
  **/
diff --git a/gdata/services/picasaweb/gdata-picasaweb-album.c b/gdata/services/picasaweb/gdata-picasaweb-album.c
index ba7e2e0..c2530b4 100644
--- a/gdata/services/picasaweb/gdata-picasaweb-album.c
+++ b/gdata/services/picasaweb/gdata-picasaweb-album.c
@@ -1177,7 +1177,7 @@ gdata_picasaweb_album_set_tags (GDataPicasaWebAlbum *self, const gchar * const *
  *
  * Returns a list of media content, such as the cover image for the album.
  *
- * Return value: a #GList of #GDataMediaContent items
+ * Return value: (element-type GData.MediaContent) (transfer none): a #GList of #GDataMediaContent items
  *
  * Since: 0.4.0
  **/
@@ -1194,7 +1194,7 @@ gdata_picasaweb_album_get_contents (GDataPicasaWebAlbum *self)
  *
  * Returns a list of thumbnails, often at different sizes, for this album.
  *
- * Return value: a #GList of #GDataMediaThumbnail<!-- -->s, or %NULL
+ * Return value: (element-type GData.MediaThumbnail) (transfer none): a #GList of #GDataMediaThumbnail<!-- -->s, or %NULL
  *
  * Since: 0.4.0
  **/
diff --git a/gdata/services/picasaweb/gdata-picasaweb-file.c b/gdata/services/picasaweb/gdata-picasaweb-file.c
index 487b5cd..81f5e31 100644
--- a/gdata/services/picasaweb/gdata-picasaweb-file.c
+++ b/gdata/services/picasaweb/gdata-picasaweb-file.c
@@ -1609,7 +1609,7 @@ gdata_picasaweb_file_set_caption (GDataPicasaWebFile *self, const gchar *caption
  *
  * Returns a list of media content, e.g. the actual photo or video.
  *
- * Return value: a #GList of #GDataMediaContent items
+ * Return value: (element-type GData.MediaContent) (transfer none): a #GList of #GDataMediaContent items
  *
  * Since: 0.4.0
  **/
@@ -1630,7 +1630,7 @@ gdata_picasaweb_file_get_contents (GDataPicasaWebFile *self)
  * not be larger than the actual image, so thumbnails may be smaller
  * than the widths listed above.
  *
- * Return value: a #GList of #GDataMediaThumbnail<!-- -->s, or %NULL
+ * Return value: (element-type GData.MediaThumbnail) (transfer none): a #GList of #GDataMediaThumbnail<!-- -->s, or %NULL
  *
  * Since: 0.4.0
  **/
diff --git a/gdata/services/youtube/gdata-youtube-video.c b/gdata/services/youtube/gdata-youtube-video.c
index 387d969..3d5a861 100644
--- a/gdata/services/youtube/gdata-youtube-video.c
+++ b/gdata/services/youtube/gdata-youtube-video.c
@@ -1205,7 +1205,7 @@ gdata_youtube_video_look_up_content (GDataYouTubeVideo *self, const gchar *type)
  *
  * Gets a list of the thumbnails available for the video.
  *
- * Return value: a #GList of #GDataMediaThumbnail<!-- -->s, or %NULL
+ * Return value: (element-type GData.MediaThumbnail) (transfer none): a #GList of #GDataMediaThumbnail<!-- -->s, or %NULL
  **/
 GList *
 gdata_youtube_video_get_thumbnails (GDataYouTubeVideo *self)
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]