From: Cosimo Cecchi <cosimoc@gnome.org>
Date: Wed, 24 Apr 2013 15:58:47 +0000 (-0400)
Subject: docs: fix docs for g_icon_[de]serialize()
X-Git-Tag: 2.37.0~11
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=03dd6cf1b55fbef243e90ee3253dacecae06cf61;p=platform%2Fupstream%2Fglib.git

docs: fix docs for g_icon_[de]serialize()
---

diff --git a/docs/reference/gio/gio-sections.txt b/docs/reference/gio/gio-sections.txt
index 4cf6d23..45fd759 100644
--- a/docs/reference/gio/gio-sections.txt
+++ b/docs/reference/gio/gio-sections.txt
@@ -448,6 +448,8 @@ g_icon_hash
 g_icon_equal
 g_icon_to_string
 g_icon_new_for_string
+g_icon_serialize
+g_icon_deserialize
 <SUBSECTION Standard>
 G_ICON
 G_IS_ICON
diff --git a/gio/gicon.c b/gio/gicon.c
index bc3f2a5..be5e5b7 100644
--- a/gio/gicon.c
+++ b/gio/gicon.c
@@ -553,6 +553,16 @@ g_icon_deserialize_emblemed (GVariant *value)
   return icon;
 }
 
+/**
+ * g_icon_deserialize:
+ * @value: a #GVariant created with g_icon_serialize()
+ *
+ * Deserializes a #GIcon previously serialized using g_icon_serialize().
+ *
+ * Returns: (transfer full): a #GIcon, or %NULL when deserialization fails.
+ *
+ * Since: 2.38
+ */
 GIcon *
 g_icon_deserialize (GVariant *value)
 {
@@ -630,6 +640,20 @@ g_icon_deserialize (GVariant *value)
   return icon;
 }
 
+/**
+ * g_icon_serialize:
+ * @icon: a #GIcon
+ *
+ * Serializes a #GIcon into a #GVariant. An equivalent #GIcon can be retrieved
+ * back by calling g_icon_deserialize() on the returned value.
+ * As serialization will avoid using raw icon data when possible, it only
+ * makes sense to transfer the #GVariant between processes on the same machine,
+ * (as opposed to over the network), and within the same file system namespace.
+ *
+ * Returns: (transfer full): a #GVariant, or %NULL when serialization fails.
+ *
+ * Since: 2.38
+ */
 GVariant *
 g_icon_serialize (GIcon *icon)
 {