From a2fc80b0ea1e33224725f541098cd72d2f26b815 Mon Sep 17 00:00:00 2001
From: Dan Williams <dcbw@redhat.com>
Date: Mon, 2 May 2011 22:37:39 -0500
Subject: [PATCH] libnm-util: document nm_utils_ip6_dns_to_gvalue()

---
 libnm-util/nm-utils.c | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/libnm-util/nm-utils.c b/libnm-util/nm-utils.c
index daa977cca0..bac7fda39a 100644
--- a/libnm-util/nm-utils.c
+++ b/libnm-util/nm-utils.c
@@ -1884,6 +1884,18 @@ nm_utils_ip6_dns_from_gvalue (const GValue *value)
 	return g_slist_reverse (list);
 }
 
+/**
+ * nm_utils_ip6_dns_to_gvalue: (skip):
+ * @list: a list of #NMIP6Route objects
+ * @value: a pointer to a #GValue into which to place the converted DNS server
+ * addresses, which should be unset by the caller (when no longer needed) with
+ * g_value_unset().
+ *
+ * Utility function to convert a #GSList of 'struct in6_addr' structs into a
+ * GPtrArray of GByteArrays representing each server's IPv6 addresses in
+ * network byte order.  The specific format of this serialization is not
+ * guaranteed to be stable and may be extended in the future.
+ */
 void
 nm_utils_ip6_dns_to_gvalue (GSList *list, GValue *value)
 {