[glib: 3/7] gasyncqueue: Add missing (transfer) and (nullable) return annotations
- From: Sebastian Dröge <sdroege src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib: 3/7] gasyncqueue: Add missing (transfer) and (nullable) return annotations
- Date: Tue, 15 Dec 2020 08:22:02 +0000 (UTC)
commit 7c3891afe9c46db2d4b479081ca8fb4c964d2a8a
Author: Philip Withnall <pwithnall endlessos org>
Date: Fri Dec 11 23:20:15 2020 +0000
gasyncqueue: Add missing (transfer) and (nullable) return annotations
This commit only looks at the `Returns:` lines in the documentation, and
has examined all of them in the file. Function arguments have not been
checked.
Signed-off-by: Philip Withnall <pwithnall endlessos org>
Helps: #2227
glib/gasyncqueue.c | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
---
diff --git a/glib/gasyncqueue.c b/glib/gasyncqueue.c
index 5719a5461..a452617fd 100644
--- a/glib/gasyncqueue.c
+++ b/glib/gasyncqueue.c
@@ -482,7 +482,7 @@ g_async_queue_pop_unlocked (GAsyncQueue *queue)
* Tries to pop data from the @queue. If no data is available,
* %NULL is returned.
*
- * Returns: data from the queue or %NULL, when no data is
+ * Returns: (nullable): data from the queue or %NULL, when no data is
* available immediately.
*/
gpointer
@@ -508,7 +508,7 @@ g_async_queue_try_pop (GAsyncQueue *queue)
*
* This function must be called while holding the @queue's lock.
*
- * Returns: data from the queue or %NULL, when no data is
+ * Returns: (nullable): data from the queue or %NULL, when no data is
* available immediately.
*/
gpointer
@@ -529,7 +529,7 @@ g_async_queue_try_pop_unlocked (GAsyncQueue *queue)
*
* If no data is received before the timeout, %NULL is returned.
*
- * Returns: data from the queue or %NULL, when no data is
+ * Returns: (nullable): data from the queue or %NULL, when no data is
* received before the timeout.
*/
gpointer
@@ -560,7 +560,7 @@ g_async_queue_timeout_pop (GAsyncQueue *queue,
*
* This function must be called while holding the @queue's lock.
*
- * Returns: data from the queue or %NULL, when no data is
+ * Returns: (nullable): data from the queue or %NULL, when no data is
* received before the timeout.
*/
gpointer
@@ -587,7 +587,7 @@ g_async_queue_timeout_pop_unlocked (GAsyncQueue *queue,
* To easily calculate @end_time, a combination of g_get_real_time()
* and g_time_val_add() can be used.
*
- * Returns: data from the queue or %NULL, when no data is
+ * Returns: (nullable): data from the queue or %NULL, when no data is
* received before @end_time.
*
* Deprecated: use g_async_queue_timeout_pop().
@@ -633,7 +633,7 @@ G_GNUC_END_IGNORE_DEPRECATIONS
*
* This function must be called while holding the @queue's lock.
*
- * Returns: data from the queue or %NULL, when no data is
+ * Returns: (nullable): data from the queue or %NULL, when no data is
* received before @end_time.
*
* Deprecated: use g_async_queue_timeout_pop_unlocked().
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]