Doc improvements

Make sure all unix-specific apis are marked as such.
This commit is contained in:
Matthias Clasen
2010-05-08 23:28:17 -04:00
parent 6bea235c8b
commit 7ca2e00054
11 changed files with 78 additions and 48 deletions

View File

@@ -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"