[glib: 7/16] gdbusmessage: Improve documentation for g_dbus_message_get_header()



commit 94a9ab3c0397d639514385c67c962e43887c5fc7
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 79bc11c16..22fcb2025 100644
--- a/gio/gdbusmessage.c
+++ b/gio/gdbusmessage.c
@@ -985,7 +985,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]