[glib/glib-2-56: 8/17] gdbusmessage: Improve documentation for g_dbus_message_get_header()
- From: Philip Withnall <pwithnall src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib/glib-2-56: 8/17] gdbusmessage: Improve documentation for g_dbus_message_get_header()
- Date: Tue, 6 Nov 2018 13:12:50 +0000 (UTC)
commit 20e8040a76271644a54f022cc06c343b069683a8
Author: Philip Withnall <withnall endlessm com>
Date: Thu Aug 16 21:35:31 2018 +0100
gdbusmessage: Improve documentation for g_dbus_message_get_header()
The caller is responsible for checking the type of the returned
GVariant.
Signed-off-by: Philip Withnall <withnall endlessm com>
gio/gdbusmessage.c | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
---
diff --git a/gio/gdbusmessage.c b/gio/gdbusmessage.c
index 5544dd820..40e7dce0c 100644
--- a/gio/gdbusmessage.c
+++ b/gio/gdbusmessage.c
@@ -983,7 +983,10 @@ g_dbus_message_set_serial (GDBusMessage *message,
*
* Gets a header field on @message.
*
- * Returns: A #GVariant with the value if the header was found, %NULL
+ * The caller is responsible for checking the type of the returned #GVariant
+ * matches what is expected.
+ *
+ * Returns: (transfer none) (nullable): A #GVariant with the value if the header was found, %NULL
* otherwise. Do not free, it is owned by @message.
*
* Since: 2.26
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]