[json-glib/json-glib-0-14] variant: Fix documentation and annotations for deserialize()



commit 240459d195e096766e06b501dead37e317215900
Author: Emmanuele Bassi <ebassi gnome org>
Date:   Wed Mar 13 14:41:23 2013 -0300

    variant: Fix documentation and annotations for deserialize()
    
    The returned GVariant when deserializing from JSON has a floating
    reference that needs to be sunk.
    (cherry picked from commit e1a55fde8a6a5cc0f1fe44ccfd54c60dd8a7aec6)
    
    Signed-off-by: Emmanuele Bassi <ebassi gnome org>

 json-glib/json-gvariant.c |   15 +++++++++++----
 1 files changed, 11 insertions(+), 4 deletions(-)
---
diff --git a/json-glib/json-gvariant.c b/json-glib/json-gvariant.c
index cae43e0..932914a 100644
--- a/json-glib/json-gvariant.c
+++ b/json-glib/json-gvariant.c
@@ -41,6 +41,7 @@
  * Use json_gvariant_deserialize() and json_gvariant_deserialize_data() to
  * obtain the #GVariant value from a #JsonNode tree or directly from a JSON
  * string.
+ *
  * Since many #GVariant data types cannot be directly represented as
  * JSON, a #GVariant type string (signature) should be provided to these
  * methods in order to obtain a correct, type-contrained result.
@@ -1261,8 +1262,11 @@ out:
  * If @signature is %NULL, the conversion is done based strictly on the types
  * in the JSON nodes.
  *
- * Return value: (transfer full): A newly created #GVariant compliant with
- *   @signature, or %NULL on error
+ * The returned variant has a floating reference that will need to be sunk
+ * by the caller code.
+ *
+ * Return value: (transfer none): A newly created, floating #GVariant
+ *   compliant with @signature, or %NULL on error
  *
  * Since: 0.14
  */
@@ -1297,8 +1301,11 @@ json_gvariant_deserialize (JsonNode     *json_node,
  * The string is first converted to a #JsonNode using #JsonParser, and then
  * json_gvariant_deserialize() is called.
  *
- * Returns: (transfer full): A newly created #GVariant compliant with
- *   @signature, or %NULL on error
+ * The returned variant has a floating reference that will need to be sunk
+ * by the caller code.
+ *
+ * Returns: (transfer none): A newly created, floating #GVariant compliant
+ *   with @signature, or %NULL on error
  *
  * Since: 0.14
  */


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]