From d470e7227a4405262d5f0f4945dbe855d3adf60d Mon Sep 17 00:00:00 2001 From: Philip Withnall Date: Tue, 15 Nov 2022 17:45:59 +0000 Subject: [PATCH] gaction: Improve documentation around floating GVariants Signed-off-by: Philip Withnall --- gio/gaction.c | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/gio/gaction.c b/gio/gaction.c index 5394a1ae7..5599137fd 100644 --- a/gio/gaction.c +++ b/gio/gaction.c @@ -467,6 +467,12 @@ g_action_name_is_valid (const gchar *action_name) * For strings, this third format must be used if target value is * empty or contains characters other than alphanumerics, `-` and `.`. * + * If this function returns %TRUE, a non-%NULL value is guaranteed to be returned + * in @action_name (if a pointer is passed in). A %NULL value may still be + * returned in @target_value, as the @detailed_name may not contain a target. + * + * If returned, the #GVariant in @target_value is guaranteed to not be floating. + * * Returns: %TRUE if successful, else %FALSE with @error set * * Since: 2.38