luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-03-31 21:03:10 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'update-annotations' into 'main'

Browse Source 
Update annotations for GAsyncQueue and GDir

See merge request GNOME/glib!3566
This commit is contained in:
Philip Withnall 2023-10-03 09:11:42 +00:00
commit ee56c7697b
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
glib/gasyncqueue.c
View File

@ -111,11 +111,11 @@ typedef struct
} SortData; } SortData;
/** /**
* g_async_queue_new: * g_async_queue_new: (constructor)
* *
* Creates a new asynchronous queue. * Creates a new asynchronous queue.
* *
* Returns: a new #GAsyncQueue. Free with g_async_queue_unref() * Returns: (transfer full): a new #GAsyncQueue. Free with g_async_queue_unref()
*/ */
GAsyncQueue * GAsyncQueue *
g_async_queue_new (void) g_async_queue_new (void)
@ -124,14 +124,14 @@ g_async_queue_new (void)
} }
/** /**
* g_async_queue_new_full: * g_async_queue_new_full: (constructor)
* @item_free_func: (nullable): function to free queue elements * @item_free_func: (nullable): function to free queue elements
* *
* Creates a new asynchronous queue and sets up a destroy notify * Creates a new asynchronous queue and sets up a destroy notify
* function that is used to free any remaining queue items when * function that is used to free any remaining queue items when
* the queue is destroyed after the final unref. * the queue is destroyed after the final unref.
* *
* Returns: a new #GAsyncQueue. Free with g_async_queue_unref() * Returns: (transfer full): a new #GAsyncQueue. Free with g_async_queue_unref()
* *
* Since: 2.16 * Since: 2.16
*/ */
@ -158,7 +158,7 @@ g_async_queue_new_full (GDestroyNotify item_free_func)
* Increases the reference count of the asynchronous @queue by 1. * Increases the reference count of the asynchronous @queue by 1.
* You do not need to hold the lock to call this function. * You do not need to hold the lock to call this function.
* *
* Returns: the @queue that was passed in (since 2.6) * Returns: (transfer full): the @queue that was passed in (since 2.6)
*/ */
GAsyncQueue * GAsyncQueue *
g_async_queue_ref (GAsyncQueue *queue) g_async_queue_ref (GAsyncQueue *queue)
@ -212,7 +212,7 @@ g_async_queue_unref_and_unlock (GAsyncQueue *queue)
/** /**
* g_async_queue_unref: * g_async_queue_unref:
* @queue: a #GAsyncQueue. * @queue: (transfer full): a #GAsyncQueue.
* *
* Decreases the reference count of the asynchronous @queue by 1. * Decreases the reference count of the asynchronous @queue by 1.
* *

6
glib/gdir.c
View File

@ -120,7 +120,7 @@ g_dir_open_with_errno (const gchar *path,
} }
/** /**
* g_dir_open: * g_dir_open: (constructor)
* @path: the path to the directory you are interested in. On Unix * @path: the path to the directory you are interested in. On Unix
* in the on-disk encoding. On Windows in UTF-8 * in the on-disk encoding. On Windows in UTF-8
* @flags: Currently must be set to 0. Reserved for future use. * @flags: Currently must be set to 0. Reserved for future use.
@ -132,7 +132,7 @@ g_dir_open_with_errno (const gchar *path,
* directory can then be retrieved using g_dir_read_name(). Note * directory can then be retrieved using g_dir_read_name(). Note
* that the ordering is not defined. * that the ordering is not defined.
* *
* Returns: a newly allocated #GDir on success, %NULL on failure. * Returns: (transfer full): a newly allocated #GDir on success, %NULL on failure.
* If non-%NULL, you must free the result with g_dir_close() * If non-%NULL, you must free the result with g_dir_close()
* when you are finished with it. * when you are finished with it.
**/ **/
@ -289,7 +289,7 @@ g_dir_rewind (GDir *dir)
/** /**
* g_dir_close: * g_dir_close:
* @dir: a #GDir* created by g_dir_open() * @dir: (transfer full): a #GDir* created by g_dir_open()
* *
* Closes the directory and deallocates all related resources. * Closes the directory and deallocates all related resources.
**/ **/