Add GI annotations to GFileEnumerator
authorPavel Holejsovsky <pholejs@src.gnome.org>
Mon, 27 Dec 2010 14:48:31 +0000 (15:48 +0100)
committerPavel Holejsovsky <pholejs@src.gnome.org>
Mon, 27 Dec 2010 14:48:31 +0000 (15:48 +0100)
gio/gfileenumerator.c
gio/gfileenumerator.h

index ac7a724..b8e7339 100644 (file)
@@ -173,7 +173,7 @@ g_file_enumerator_init (GFileEnumerator *enumerator)
 /**
  * g_file_enumerator_next_file:
  * @enumerator: a #GFileEnumerator.
- * @cancellable: optional #GCancellable object, %NULL to ignore.
+ * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
  * @error: location to store the error occuring, or %NULL to ignore
  *
  * Returns information for the next file in the enumerated object.
@@ -238,7 +238,7 @@ g_file_enumerator_next_file (GFileEnumerator *enumerator,
 /**
  * g_file_enumerator_close:
  * @enumerator: a #GFileEnumerator.
- * @cancellable: optional #GCancellable object, %NULL to ignore. 
+ * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. 
  * @error: location to store the error occuring, or %NULL to ignore
  *
  * Releases all resources used by this enumerator, making the
@@ -305,9 +305,9 @@ next_async_callback_wrapper (GObject      *source_object,
  * @num_files: the number of file info objects to request
  * @io_priority: the <link linkend="gioscheduler">io priority</link> 
  *     of the request. 
- * @cancellable: optional #GCancellable object, %NULL to ignore.
- * @callback: a #GAsyncReadyCallback to call when the request is satisfied
- * @user_data: the data to pass to callback function
+ * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
+ * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
+ * @user_data: (closure): the data to pass to callback function
  *
  * Request information for a number of files from the enumerator asynchronously.
  * When all i/o for the operation is finished the @callback will be called with
@@ -439,9 +439,9 @@ close_async_callback_wrapper (GObject      *source_object,
  * @enumerator: a #GFileEnumerator.
  * @io_priority: the <link linkend="io-priority">I/O priority</link> 
  *     of the request.
- * @cancellable: optional #GCancellable object, %NULL to ignore. 
- * @callback: a #GAsyncReadyCallback to call when the request is satisfied
- * @user_data: the data to pass to callback function
+ * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. 
+ * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
+ * @user_data: (closure): the data to pass to callback function
  *
  * Asynchronously closes the file enumerator. 
  *
index a0cfaaf..9cd2f3e 100644 (file)
@@ -74,7 +74,7 @@ struct _GFileEnumeratorClass
                                      GAsyncReadyCallback   callback,
                                      gpointer              user_data);
   GList *     (* next_files_finish) (GFileEnumerator      *enumerator,
-                                     GAsyncResult         *res,
+                                     GAsyncResult         *result,
                                      GError              **error);
   void        (* close_async)       (GFileEnumerator      *enumerator,
                                      int                   io_priority,
@@ -82,7 +82,7 @@ struct _GFileEnumeratorClass
                                      GAsyncReadyCallback   callback,
                                      gpointer              user_data);
   gboolean    (* close_finish)      (GFileEnumerator      *enumerator,
-                                     GAsyncResult         *res,
+                                     GAsyncResult         *result,
                                      GError              **error);
 
   /*< private >*/