summaryrefslogtreecommitdiff
path: root/gio/gunixfdmessage.c
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2010-05-08 23:28:17 -0400
committerMatthias Clasen <mclasen@redhat.com>2010-05-08 23:28:17 -0400
commit7ca2e000546733446f737ec8fe425dd17218eada (patch)
treea2c1fd6da5ff7a8d3ee679df353fdc6a23259027 /gio/gunixfdmessage.c
parent6bea235c8b3bb79b508491985dd38c2074ee6843 (diff)
downloadglib-7ca2e000546733446f737ec8fe425dd17218eada.tar.gz
Doc improvements
Make sure all unix-specific apis are marked as such.
Diffstat (limited to 'gio/gunixfdmessage.c')
-rw-r--r--gio/gunixfdmessage.c13
1 files changed, 9 insertions, 4 deletions
diff --git a/gio/gunixfdmessage.c b/gio/gunixfdmessage.c
index bb37d5f59..90f87c34b 100644
--- a/gio/gunixfdmessage.c
+++ b/gio/gunixfdmessage.c
@@ -15,18 +15,23 @@
/**
* SECTION: gunixfdmessage
* @title: GUnixFDMessage
- * @short_description: A GSocketControlMessage containing a #GUnixFDList
+ * @short_description: A GSocketControlMessage containing a GUnixFDList
+ * @include: gio/gunixfdmessage.h
* @see_also: #GUnixConnection, #GUnixFDList, #GSocketControlMessage
*
- * This #GSocketControlMessage contains a #GUnixFDList. It may be sent
- * using g_socket_send_message() and received using
+ * This #GSocketControlMessage contains a #GUnixFDList.
+ * It may be sent using g_socket_send_message() and received using
* g_socket_receive_message() over UNIX sockets (ie: sockets in the
- * %G_SOCKET_ADDRESS_UNIX family). The file descriptors are copied
+ * %G_SOCKET_ADDRESS_UNIX family). The file descriptors are copied
* between processes by the kernel.
*
* For an easier way to send and receive file descriptors over
* stream-oriented UNIX sockets, see g_unix_connection_send_fd() and
* g_unix_connection_receive_fd().
+ *
+ * Note that <filename>&lt;gio/gunixfdmessage.h&gt;</filename> belongs to
+ * the UNIX-specific GIO interfaces, thus you have to use the
+ * <filename>gio-unix-2.0.pc</filename> pkg-config file when using it.
**/
#include "config.h"