[libgdata] [introspection] Add (closure) annotations

From: Philip Withnall <pwithnall src gnome org>
To: commits-list gnome org
Cc:
Subject: [libgdata] [introspection] Add (closure) annotations
Date: Mon, 26 Jul 2010 07:43:33 +0000 (UTC)
commit ac4e1b6e9a991c6d029b62a1aa43e63861061f53
Author: Philip Withnall <philip withnall collabora co uk>
Date:   Mon Jul 26 00:29:39 2010 +0200

    [introspection] Add (closure) annotations

 gdata/gdata-access-handler.c                       |    2 +-
 gdata/gdata-batch-operation.c                      |   10 +++++-----
 gdata/gdata-service.c                              |   16 ++++++++--------
 gdata/services/calendar/gdata-calendar-service.c   |   14 +++++++-------
 gdata/services/contacts/gdata-contacts-service.c   |    6 +++---
 gdata/services/documents/gdata-documents-service.c |    4 ++--
 gdata/services/picasaweb/gdata-picasaweb-service.c |   10 +++++-----
 gdata/services/youtube/gdata-youtube-service.c     |   20 ++++++++++----------
 8 files changed, 41 insertions(+), 41 deletions(-)
---
diff --git a/gdata/gdata-access-handler.c b/gdata/gdata-access-handler.c
index 97b5941..2e7f3f6 100644
--- a/gdata/gdata-access-handler.c
+++ b/gdata/gdata-access-handler.c
@@ -62,7 +62,7 @@ gdata_access_handler_get_type (void)
  * @service: a #GDataService
  * @cancellable: optional #GCancellable object, or %NULL
  * @progress_callback: a #GDataQueryProgressCallback to call when a rule is loaded, or %NULL
- * @progress_user_data: data to pass to the @progress_callback function
+ * @progress_user_data: (closure): data to pass to the @progress_callback function
  * @error: a #GError, or %NULL
  *
  * Retrieves a #GDataFeed containing all the access rules which apply to the given #GDataAccessHandler. Only the owner of a #GDataAccessHandler may
diff --git a/gdata/gdata-batch-operation.c b/gdata/gdata-batch-operation.c
index e0e23df..87a156e 100644
--- a/gdata/gdata-batch-operation.c
+++ b/gdata/gdata-batch-operation.c
@@ -375,7 +375,7 @@ operation_free (BatchOperation *op)
  * @id: the ID of the entry being queried for
  * @entry_type: the type of the entry which will be returned
  * @callback: a #GDataBatchOperationCallback to call when the query is finished, or %NULL
- * @user_data: data to pass to the @callback function
+ * @user_data: (closure): data to pass to the @callback function
  *
  * Add a query to the #GDataBatchOperation, to be executed when the operation is run. The query will return a #GDataEntry (of subclass type
  * @entry_type) representing the given entry @id. The ID is of the same format as that returned by gdata_entry_get_id().
@@ -424,7 +424,7 @@ gdata_batch_operation_add_query (GDataBatchOperation *self, const gchar *id, GTy
  * @self: a #GDataBatchOperation
  * @entry: the #GDataEntry to insert
  * @callback: a #GDataBatchOperationCallback to call when the insertion is finished, or %NULL
- * @user_data: data to pass to the @callback function
+ * @user_data: (closure): data to pass to the @callback function
  *
  * Add an entry to the #GDataBatchOperation, to be inserted on the server when the operation is run. The insertion will return the inserted version
  * of @entry. @entry is reffed by the function, so may be freed after it returns.
@@ -451,7 +451,7 @@ gdata_batch_operation_add_insertion (GDataBatchOperation *self, GDataEntry *entr
  * @self: a #GDataBatchOperation
  * @entry: the #GDataEntry to update
  * @callback: a #GDataBatchOperationCallback to call when the update is finished, or %NULL
- * @user_data: data to pass to the @callback function
+ * @user_data: (closure): data to pass to the @callback function
  *
  * Add an entry to the #GDataBatchOperation, to be updated on the server when the operation is run. The update will return the updated version of
  * @entry. @entry is reffed by the function, so may be freed after it returns.
@@ -481,7 +481,7 @@ gdata_batch_operation_add_update (GDataBatchOperation *self, GDataEntry *entry,
  * @self: a #GDataBatchOperation
  * @entry: the #GDataEntry to delete
  * @callback: a #GDataBatchOperationCallback to call when the deletion is finished, or %NULL
- * @user_data: data to pass to the @callback function
+ * @user_data: (closure): data to pass to the @callback function
  *
  * Add an entry to the #GDataBatchOperation, to be deleted on the server when the operation is run. @entry is reffed by the function, so may be freed
  * after it returns.
@@ -634,7 +634,7 @@ run_thread (GSimpleAsyncResult *result, GDataBatchOperation *operation, GCancell
  * @self: a #GDataBatchOperation
  * @cancellable: a #GCancellable, or %NULL
  * @callback: a #GAsyncReadyCallback to call when the batch operation is finished, or %NULL
- * @user_data: data to pass to the @callback function
+ * @user_data: (closure): data to pass to the @callback function
  *
  * Run the #GDataBatchOperation asynchronously. This will send all the operations in the batch operation to the server, and call their respective
  * callbacks asynchronously (i.e. in idle functions in the main thread, usually after gdata_batch_operation_run_async() has returned) as the
diff --git a/gdata/gdata-service.c b/gdata/gdata-service.c
index 03372a1..15af813 100644
--- a/gdata/gdata-service.c
+++ b/gdata/gdata-service.c
@@ -803,7 +803,7 @@ authenticate_thread (GSimpleAsyncResult *result, GDataService *service, GCancell
  * @password: the user's password
  * @cancellable: optional #GCancellable object, or %NULL
  * @callback: a #GAsyncReadyCallback to call when authentication is finished
- * @user_data: data to pass to the @callback function
+ * @user_data: (closure): data to pass to the @callback function
  *
  * Authenticates the #GDataService with the online service using the given @username and @password. @self, @username and
  * @password are all reffed/copied when this function is called, so can safely be freed after this function returns.
@@ -1049,9 +1049,9 @@ query_thread (GSimpleAsyncResult *result, GDataService *service, GCancellable *c
  * @entry_type: a #GType for the #GDataEntry<!-- -->s to build from the XML
  * @cancellable: optional #GCancellable object, or %NULL
  * @progress_callback: a #GDataQueryProgressCallback to call when an entry is loaded, or %NULL
- * @progress_user_data: data to pass to the @progress_callback function
+ * @progress_user_data: (closure): data to pass to the @progress_callback function
  * @callback: a #GAsyncReadyCallback to call when the query is finished
- * @user_data: data to pass to the @callback function
+ * @user_data: (closure): data to pass to the @callback function
  *
  * Queries the service's @feed_uri feed to build a #GDataFeed. @self, @feed_uri and
  * @query are all reffed/copied when this function is called, so can safely be freed after this function returns.
@@ -1183,7 +1183,7 @@ _gdata_service_query (GDataService *self, const gchar *feed_uri, GDataQuery *que
  * @entry_type: a #GType for the #GDataEntry<!-- -->s to build from the XML
  * @cancellable: optional #GCancellable object, or %NULL
  * @progress_callback: a #GDataQueryProgressCallback to call when an entry is loaded, or %NULL
- * @progress_user_data: data to pass to the @progress_callback function
+ * @progress_user_data: (closure): data to pass to the @progress_callback function
  * @error: a #GError, or %NULL
  *
  * Queries the service's @feed_uri feed to build a #GDataFeed.
@@ -1350,7 +1350,7 @@ query_single_entry_thread (GSimpleAsyncResult *result, GDataService *service, GC
  * @entry_type: a #GType for the #GDataEntry to build from the XML
  * @cancellable: optional #GCancellable object, or %NULL
  * @callback: a #GAsyncReadyCallback to call when the query is finished
- * @user_data: data to pass to the @callback function
+ * @user_data: (closure): data to pass to the @callback function
  *
  * Retrieves information about the single entry with the given @entry_id. @entry_id should be as returned by
  * gdata_entry_get_id(). @self, @query and @entry_id are reffed/copied when this
@@ -1462,7 +1462,7 @@ insert_entry_thread (GSimpleAsyncResult *result, GDataService *service, GCancell
  * @entry: the #GDataEntry to insert
  * @cancellable: optional #GCancellable object, or %NULL
  * @callback: a #GAsyncReadyCallback to call when insertion is finished, or %NULL
- * @user_data: data to pass to the @callback function
+ * @user_data: (closure): data to pass to the @callback function
  *
  * Inserts @entry by uploading it to the online service at @upload_uri. @self, @upload_uri and
  * @entry are all reffed/copied when this function is called, so can safely be freed after this function returns.
@@ -1631,7 +1631,7 @@ update_entry_thread (GSimpleAsyncResult *result, GDataService *service, GCancell
  * @entry: the #GDataEntry to update
  * @cancellable: optional #GCancellable object, or %NULL
  * @callback: a #GAsyncReadyCallback to call when the update is finished, or %NULL
- * @user_data: data to pass to the @callback function
+ * @user_data: (closure): data to pass to the @callback function
  *
  * Updates @entry by PUTting it to its <literal>edit</literal> link's URI. @self and
  * @entry are both reffed when this function is called, so can safely be unreffed after this function returns.
@@ -1788,7 +1788,7 @@ delete_entry_thread (GSimpleAsyncResult *result, GDataService *service, GCancell
  * @entry: the #GDataEntry to delete
  * @cancellable: optional #GCancellable object, or %NULL
  * @callback: a #GAsyncReadyCallback to call when deletion is finished, or %NULL
- * @user_data: data to pass to the @callback function
+ * @user_data: (closure): data to pass to the @callback function
  *
  * Deletes @entry from the server. @self and @entry are both reffed when this function is called,
  * so can safely be unreffed after this function returns.
diff --git a/gdata/services/calendar/gdata-calendar-service.c b/gdata/services/calendar/gdata-calendar-service.c
index 5e466c8..225b003 100644
--- a/gdata/services/calendar/gdata-calendar-service.c
+++ b/gdata/services/calendar/gdata-calendar-service.c
@@ -81,7 +81,7 @@ gdata_calendar_service_new (const gchar *client_id)
  * @query: a #GDataQuery with the query parameters, or %NULL
  * @cancellable: optional #GCancellable object, or %NULL
  * @progress_callback: a #GDataQueryProgressCallback to call when an entry is loaded, or %NULL
- * @progress_user_data: data to pass to the @progress_callback function
+ * @progress_user_data: (closure): data to pass to the @progress_callback function
  * @error: a #GError, or %NULL
  *
  * Queries the service to return a list of all calendars from the authenticated account which match the given
@@ -125,9 +125,9 @@ gdata_calendar_service_query_all_calendars (GDataCalendarService *self, GDataQue
  * @query: a #GDataQuery with the query parameters, or %NULL
  * @cancellable: optional #GCancellable object, or %NULL
  * @progress_callback: a #GDataQueryProgressCallback to call when an entry is loaded, or %NULL
- * @progress_user_data: data to pass to the @progress_callback function
+ * @progress_user_data: (closure): data to pass to the @progress_callback function
  * @callback: a #GAsyncReadyCallback to call when authentication is finished
- * @user_data: data to pass to the @callback function
+ * @user_data: (closure): data to pass to the @callback function
  *
  * Queries the service to return a list of all calendars from the authenticated account which match the given
  * @query. @self and @query are all reffed when this function is called, so can safely be unreffed after
@@ -168,7 +168,7 @@ gdata_calendar_service_query_all_calendars_async (GDataCalendarService *self, GD
  * @query: a #GDataQuery with the query parameters, or %NULL
  * @cancellable: optional #GCancellable object, or %NULL
  * @progress_callback: a #GDataQueryProgressCallback to call when an entry is loaded, or %NULL
- * @progress_user_data: data to pass to the @progress_callback function
+ * @progress_user_data: (closure): data to pass to the @progress_callback function
  * @error: a #GError, or %NULL
  *
  * Queries the service to return a list of calendars from the authenticated account which match the given
@@ -212,9 +212,9 @@ gdata_calendar_service_query_own_calendars (GDataCalendarService *self, GDataQue
  * @query: a #GDataQuery with the query parameters, or %NULL
  * @cancellable: optional #GCancellable object, or %NULL
  * @progress_callback: a #GDataQueryProgressCallback to call when an entry is loaded, or %NULL
- * @progress_user_data: data to pass to the @progress_callback function
+ * @progress_user_data: (closure): data to pass to the @progress_callback function
  * @callback: a #GAsyncReadyCallback to call when authentication is finished
- * @user_data: data to pass to the @callback function
+ * @user_data: (closure): data to pass to the @callback function
  *
  * Queries the service to return a list of calendars from the authenticated account which match the given
  * @query, and the authenticated user owns. @self and @query are all reffed when this function is called,
@@ -256,7 +256,7 @@ gdata_calendar_service_query_own_calendars_async (GDataCalendarService *self, GD
  * @query: a #GDataQuery with the query parameters, or %NULL
  * @cancellable: optional #GCancellable object, or %NULL
  * @progress_callback: a #GDataQueryProgressCallback to call when an entry is loaded, or %NULL
- * @progress_user_data: data to pass to the @progress_callback function
+ * @progress_user_data: (closure): data to pass to the @progress_callback function
  * @error: a #GError, or %NULL
  *
  * Queries the service to return a list of events in the given @calendar, which match @query.
diff --git a/gdata/services/contacts/gdata-contacts-service.c b/gdata/services/contacts/gdata-contacts-service.c
index b0c26da..d4b4447 100644
--- a/gdata/services/contacts/gdata-contacts-service.c
+++ b/gdata/services/contacts/gdata-contacts-service.c
@@ -87,7 +87,7 @@ gdata_contacts_service_new (const gchar *client_id)
  * @query: a #GDataQuery with the query parameters, or %NULL
  * @cancellable: optional #GCancellable object, or %NULL
  * @progress_callback: a #GDataQueryProgressCallback to call when an entry is loaded, or %NULL
- * @progress_user_data: data to pass to the @progress_callback function
+ * @progress_user_data: (closure): data to pass to the @progress_callback function
  * @error: a #GError, or %NULL
  *
  * Queries the service to return a list of contacts matching the given @query.
@@ -131,9 +131,9 @@ gdata_contacts_service_query_contacts (GDataContactsService *self, GDataQuery *q
  * @query: a #GDataQuery with the query parameters, or %NULL
  * @cancellable: optional #GCancellable object, or %NULL
  * @progress_callback: a #GDataQueryProgressCallback to call when an entry is loaded, or %NULL
- * @progress_user_data: data to pass to the @progress_callback function
+ * @progress_user_data: (closure): data to pass to the @progress_callback function
  * @callback: a #GAsyncReadyCallback to call when authentication is finished
- * @user_data: data to pass to the @callback function
+ * @user_data: (closure): data to pass to the @callback function
  *
  * Queries the service to return a list of contacts matching the given @query. @self and
  * @query are all reffed when this function is called, so can safely be unreffed after this function returns.
diff --git a/gdata/services/documents/gdata-documents-service.c b/gdata/services/documents/gdata-documents-service.c
index a0162fe..150cbe2 100644
--- a/gdata/services/documents/gdata-documents-service.c
+++ b/gdata/services/documents/gdata-documents-service.c
@@ -168,7 +168,7 @@ gdata_documents_service_new (const gchar *client_id)
  * @query: a #GDataDocumentsQuery with the query parameters, or %NULL
  * @cancellable: optional #GCancellable object, or %NULL
  * @progress_callback: a #GDataQueryProgressCallback to call when an entry is loaded, or %NULL
- * @progress_user_data: data to pass to the @progress_callback function
+ * @progress_user_data: (closure): data to pass to the @progress_callback function
  * @error: a #GError, or %NULL
  *
  * Queries the service to return a list of documents matching the given @query. Note that @query has to be a #GDataDocumentsQuery, rather than just
@@ -221,7 +221,7 @@ gdata_documents_service_query_documents (GDataDocumentsService *self, GDataDocum
  * @progress_callback: a #GDataQueryProgressCallback to call when an entry is loaded, or %NULL
  * @progress_user_data: data to pass to the @progress_callback function
  * @callback: a #GAsyncReadyCallback to call when authentication is finished
- * @user_data: data to pass to the @callback function
+ * @user_data: (closure): data to pass to the @callback function
  *
  * Queries the service to return a list of documents matching the given @query. @self and
  * @query are both reffed when this function is called, so can safely be unreffed after this function returns.
diff --git a/gdata/services/picasaweb/gdata-picasaweb-service.c b/gdata/services/picasaweb/gdata-picasaweb-service.c
index 3782e3c..a1d6e4f 100644
--- a/gdata/services/picasaweb/gdata-picasaweb-service.c
+++ b/gdata/services/picasaweb/gdata-picasaweb-service.c
@@ -207,7 +207,7 @@ gdata_picasaweb_service_get_user (GDataPicasaWebService *self, const gchar *user
  * @username: the username of the user whose albums you wish to retrieve, or %NULL
  * @cancellable: optional #GCancellable object, or %NULL
  * @progress_callback: a #GDataQueryProgressCallback to call when an entry is loaded, or %NULL
- * @progress_user_data: data to pass to the @progress_callback function
+ * @progress_user_data: (closure): data to pass to the @progress_callback function
  * @error: a #GError, or %NULL
  *
  * Queries the service to return a list of all albums belonging to the specified @username which match the given
@@ -263,9 +263,9 @@ gdata_picasaweb_service_query_all_albums (GDataPicasaWebService *self, GDataQuer
  * @username: the username of the user whose albums you wish to retrieve, or %NULL
  * @cancellable: optional #GCancellable object, or %NULL
  * @progress_callback: a #GDataQueryProgressCallback to call when an entry is loaded, or %NULL
- * @progress_user_data: data to pass to the @progress_callback function
+ * @progress_user_data: (closure): data to pass to the @progress_callback function
  * @callback: a #GAsyncReadyCallback to call when authentication is finished
- * @user_data: data to pass to the @callback function
+ * @user_data: (closure): data to pass to the @callback function
  *
  * Queries the service to return a list of all albums belonging to the specified @username which match the given
  * @query. @self, @query and @username are all reffed/copied when this function is called, so can safely be unreffed/freed after
@@ -317,7 +317,7 @@ gdata_picasaweb_service_query_all_albums_async (GDataPicasaWebService *self, GDa
  * @query: a #GDataQuery with the query parameters, or %NULL
  * @cancellable: optional #GCancellable object, or %NULL
  * @progress_callback: a #GDataQueryProgressCallback to call when an entry is loaded, or %NULL
- * @progress_user_data: data to pass to the @progress_callback function
+ * @progress_user_data: (closure): data to pass to the @progress_callback function
  * @error: a #GError, or %NULL
  *
  * Queries the specified @album for a list of the files which match the given @query. If @album is %NULL and a user is
@@ -571,7 +571,7 @@ upload_file_async_cb (GOutputStream *output_stream, GAsyncResult *result, Upload
  * @file_data: the actual file to upload
  * @cancellable: optional #GCancellable object, or %NULL
  * @callback: a #GAsyncReadyCallback to call when authentication is finished
- * @user_data: data to pass to the @callback function
+ * @user_data: (closure): data to pass to the @callback function
  *
  * Uploads a file (photo or video) to the given PicasaWeb @album
  * asynchronously, using the @actual_file from disk and the metadata
diff --git a/gdata/services/youtube/gdata-youtube-service.c b/gdata/services/youtube/gdata-youtube-service.c
index f041033..d0e49ab 100644
--- a/gdata/services/youtube/gdata-youtube-service.c
+++ b/gdata/services/youtube/gdata-youtube-service.c
@@ -441,7 +441,7 @@ standard_feed_type_to_feed_uri (GDataYouTubeStandardFeedType feed_type)
  * @query: a #GDataQuery with the query parameters, or %NULL
  * @cancellable: optional #GCancellable object, or %NULL
  * @progress_callback: a #GDataQueryProgressCallback to call when an entry is loaded, or %NULL
- * @progress_user_data: data to pass to the @progress_callback function
+ * @progress_user_data: (closure): data to pass to the @progress_callback function
  * @error: a #GError, or %NULL
  *
  * Queries the service's standard @feed_type feed to build a #GDataFeed.
@@ -472,9 +472,9 @@ gdata_youtube_service_query_standard_feed (GDataYouTubeService *self, GDataYouTu
  * @query: a #GDataQuery with the query parameters, or %NULL
  * @cancellable: optional #GCancellable object, or %NULL
  * @progress_callback: a #GDataQueryProgressCallback to call when an entry is loaded, or %NULL
- * @progress_user_data: data to pass to the @progress_callback function
+ * @progress_user_data: (closure): data to pass to the @progress_callback function
  * @callback: a #GAsyncReadyCallback to call when authentication is finished
- * @user_data: data to pass to the @callback function
+ * @user_data: (closure): data to pass to the @callback function
  *
  * Queries the service's standard @feed_type feed to build a #GDataFeed. @self and
  * @query are both reffed when this function is called, so can safely be freed after this function returns.
@@ -504,7 +504,7 @@ gdata_youtube_service_query_standard_feed_async (GDataYouTubeService *self, GDat
  * @query: a #GDataQuery with the query parameters, or %NULL
  * @cancellable: optional #GCancellable object, or %NULL
  * @progress_callback: a #GDataQueryProgressCallback to call when an entry is loaded, or %NULL
- * @progress_user_data: data to pass to the @progress_callback function
+ * @progress_user_data: (closure): data to pass to the @progress_callback function
  * @error: a #GError, or %NULL
  *
  * Queries the service for videos matching the parameters set on the #GDataQuery. This searches site-wide, and imposes no other restrictions or
@@ -534,9 +534,9 @@ gdata_youtube_service_query_videos (GDataYouTubeService *self, GDataQuery *query
  * @query: a #GDataQuery with the query parameters, or %NULL
  * @cancellable: optional #GCancellable object, or %NULL
  * @progress_callback: a #GDataQueryProgressCallback to call when an entry is loaded, or %NULL
- * @progress_user_data: data to pass to the @progress_callback function
+ * @progress_user_data: (closure): data to pass to the @progress_callback function
  * @callback: a #GAsyncReadyCallback to call when authentication is finished
- * @user_data: data to pass to the @callback function
+ * @user_data: (closure): data to pass to the @callback function
  *
  * Queries the service for videos matching the parameters set on the #GDataQuery. This searches site-wide, and imposes no other restrictions or
  * parameters on the query. @self and @query are both reffed when this function is called, so can safely be freed after this function returns.
@@ -567,7 +567,7 @@ gdata_youtube_service_query_videos_async (GDataYouTubeService *self, GDataQuery
  * @query: a #GDataQuery with the query parameters, or %NULL
  * @cancellable: optional #GCancellable object, or %NULL
  * @progress_callback: a #GDataQueryProgressCallback to call when an entry is loaded, or %NULL
- * @progress_user_data: data to pass to the @progress_callback function
+ * @progress_user_data: (closure): data to pass to the @progress_callback function
  * @error: a #GError, or %NULL
  *
  * Queries the service for videos related to @video. The algorithm determining which videos are related is on the server side.
@@ -611,9 +611,9 @@ gdata_youtube_service_query_related (GDataYouTubeService *self, GDataYouTubeVide
  * @query: a #GDataQuery with the query parameters, or %NULL
  * @cancellable: optional #GCancellable object, or %NULL
  * @progress_callback: a #GDataQueryProgressCallback to call when an entry is loaded, or %NULL
- * @progress_user_data: data to pass to the @progress_callback function
+ * @progress_user_data: (closure): data to pass to the @progress_callback function
  * @callback: a #GAsyncReadyCallback to call when authentication is finished
- * @user_data: data to pass to the @callback function
+ * @user_data: (closure): data to pass to the @callback function
  *
  * Queries the service for videos related to @video. The algorithm determining which videos are related is on the server side.
  * @self and @query are both reffed when this function is called, so can safely be freed after this function returns.
@@ -832,7 +832,7 @@ get_categories_thread (GSimpleAsyncResult *result, GDataYouTubeService *service,
  * @self: a #GDataYouTubeService
  * @cancellable: optional #GCancellable object, or %NULL
  * @callback: a #GAsyncReadyCallback to call when the request is finished
- * @user_data: data to pass to the @callback function
+ * @user_data: (closure): data to pass to the @callback function
  *
  * Gets a list of the categories currently in use on YouTube. @self is reffed when this function is called, so can safely be unreffed after this
  * function returns.
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]