summaryrefslogtreecommitdiff
path: root/telepathy-glib/gnio-util.c
diff options
context:
space:
mode:
authorDanielle Madeley <danielle.madeley@collabora.co.uk>2009-07-13 13:32:28 +0100
committerDanielle Madeley <danielle.madeley@collabora.co.uk>2010-02-23 09:53:35 +1100
commit40de1451bc17409db01797830a93f7cacbab4c75 (patch)
tree33c5eb8a7dfda5f028915669c5059d9351f5aedc /telepathy-glib/gnio-util.c
parent7df1022ccfcfdb8c22164a4b478c114d9d283a52 (diff)
downloadtelepathy-glib-40de1451bc17409db01797830a93f7cacbab4c75.tar.gz
Include in gtk-doc
Diffstat (limited to 'telepathy-glib/gnio-util.c')
-rw-r--r--telepathy-glib/gnio-util.c9
1 files changed, 9 insertions, 0 deletions
diff --git a/telepathy-glib/gnio-util.c b/telepathy-glib/gnio-util.c
index 291da23a7..37ed12872 100644
--- a/telepathy-glib/gnio-util.c
+++ b/telepathy-glib/gnio-util.c
@@ -24,6 +24,15 @@
* @short_description: Telepathy/GNIO utility functions
*
* Utility functions for interacting between Telepathy and GNIO.
+ *
+ * Telepathy uses address variants stored in #GValue boxes for communicating
+ * network socket addresses over D-Bus to and from the Connection Manager
+ * (for instance when using the file transfer and stream tube APIs).
+ *
+ * This API provides translation between #GSocketAddress subtypes and a #GValue
+ * that can be used by telepathy-glib.
+ * #GInetSocketAddress is used for IPv4/IPv6 and #GUnixSocketAddress
+ * for UNIX sockets (only available on platforms with gio-unix).
*/
#include <config.h>