hook gvariant vectors up to kdbus

[platform/upstream/glib.git] / gio / gfileenumerator.c

diff --git a/gio/gfileenumerator.c b/gio/gfileenumerator.c
index 9146b65..c0d4054 100644 (file)
--- a/gio/gfileenumerator.c
+++ b/gio/gfileenumerator.c
@@ -41,7 +41,7 @@ struct _GFileEnumeratorPrivate {
  * @short_description: Enumerated Files Routines
  * @include: gio/gio.h
  * 
- * #GFileEnumerator allows you to operate on a set of #GFile<!-- -->s, 
+ * #GFileEnumerator allows you to operate on a set of #GFiles, 
  * returning a #GFileInfo structure for each file enumerated (e.g. 
  * g_file_enumerate_children() will return a #GFileEnumerator for each 
  * of the children within a directory).
@@ -49,7 +49,7 @@ struct _GFileEnumeratorPrivate {
  * To get the next file's information from a #GFileEnumerator, use 
  * g_file_enumerator_next_file() or its asynchronous version, 
  * g_file_enumerator_next_files_async(). Note that the asynchronous 
- * version will return a list of #GFileInfo<!---->s, whereas the 
+ * version will return a list of #GFileInfos, whereas the 
  * synchronous will only return the next file in the enumerator.
  *
  * The ordering of returned files is unspecified for non-Unix
@@ -191,8 +191,9 @@ g_file_enumerator_init (GFileEnumerator *enumerator)
  * enumerator is at the end, %NULL will be returned and @error will
  * be unset.
  *
- * Return value: (transfer full): A #GFileInfo or %NULL on error or end of enumerator.
- *    Free the returned object with g_object_unref() when no longer needed.
+ * Returns: (nullable) (transfer full): A #GFileInfo or %NULL on error
+ *    or end of enumerator.  Free the returned object with
+ *    g_object_unref() when no longer needed.
  **/
 GFileInfo *
 g_file_enumerator_next_file (GFileEnumerator *enumerator,
@@ -254,7 +255,7 @@ g_file_enumerator_next_file (GFileEnumerator *enumerator,
  * is dropped, but you might want to call this function to make 
  * sure resources are released as early as possible.
  *
- * Return value: #TRUE on success or #FALSE on error.
+ * Returns: #TRUE on success or #FALSE on error.
  **/
 gboolean
 g_file_enumerator_close (GFileEnumerator  *enumerator,
@@ -309,8 +310,7 @@ next_async_callback_wrapper (GObject      *source_object,
  * g_file_enumerator_next_files_async:
  * @enumerator: a #GFileEnumerator.
  * @num_files: the number of file info objects to request
- * @io_priority: the <link linkend="io-priority">io priority</link>
- *     of the request. 
+ * @io_priority: the [I/O priority][io-priority] of the request 
  * @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
@@ -396,7 +396,7 @@ g_file_enumerator_next_files_async (GFileEnumerator     *enumerator,
  * 
  * Finishes the asynchronous operation started with g_file_enumerator_next_files_async().
  * 
- * Returns: (transfer full) (element-type Gio.FileInfo): a #GList of #GFileInfo<!---->s. You must free the list with 
+ * Returns: (transfer full) (element-type Gio.FileInfo): a #GList of #GFileInfos. You must free the list with 
  *     g_list_free() and unref the infos with g_object_unref() when you're 
  *     done with them.
  **/
@@ -436,8 +436,7 @@ close_async_callback_wrapper (GObject      *source_object,
 /**
  * g_file_enumerator_close_async:
  * @enumerator: a #GFileEnumerator.
- * @io_priority: the <link linkend="io-priority">I/O priority</link> 
- *     of the request.
+ * @io_priority: the [I/O priority][io-priority] of the request
  * @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
@@ -603,7 +602,7 @@ g_file_enumerator_get_container (GFileEnumerator *enumerator)
  * inside loops with g_file_enumerator_next_file().
  *
  * This is a convenience method that's equivalent to:
- * |[
+ * |[<!-- language="C" -->
  *   gchar *name = g_file_info_get_name (info);
  *   GFile *child = g_file_get_child (g_file_enumerator_get_container (enumr),
  *                                    name);