luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-03-14 19:55:12 +01:00
Code Issues Packages Projects Releases Wiki Activity

Doc improvements

Browse Source 
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/reference/gio/gio-docs.xml
View File

@ -98,7 +98,7 @@
<xi:include href="xml/gasyncinitable.xml"/>
</chapter>
<chapter id="networking">
<title>Lowlevel platform-independent network support</title>
<title>Lowlevel network support</title>
<xi:include href="xml/gsocket.xml"/>
<xi:include href="xml/ginetaddress.xml"/>
<xi:include href="xml/gsocketaddress.xml"/>
@ -108,6 +108,15 @@
<xi:include href="xml/gunixfdlist.xml"/>
<xi:include href="xml/gunixfdmessage.xml"/>
</chapter>
<chapter id="highlevel-socket">
<title>Highlevel network support</title>
<xi:include href="xml/gsocketclient.xml"/>
<xi:include href="xml/gsocketconnection.xml"/>
<xi:include href="xml/gunixconnection.xml"/>
<xi:include href="xml/gsocketlistener.xml"/>
<xi:include href="xml/gsocketservice.xml"/>
<xi:include href="xml/gthreadedsocketservice.xml"/>
</chapter>
<chapter id="resolver">
<title>DNS resolution</title>
<xi:include href="xml/gresolver.xml"/>
@ -116,14 +125,6 @@
<xi:include href="xml/gnetworkservice.xml"/>
<xi:include href="xml/gsrvtarget.xml"/>
</chapter>
<chapter id="highlevel-socket">
<title>Highlevel network functionallity</title>
<xi:include href="xml/gsocketclient.xml"/>
<xi:include href="xml/gsocketconnection.xml"/>
<xi:include href="xml/gsocketlistener.xml"/>
<xi:include href="xml/gsocketservice.xml"/>
<xi:include href="xml/gthreadedsocketservice.xml"/>
</chapter>
<chapter id="utils">
<title>Utilities</title>
<xi:include href="xml/gfilenamecompleter.xml"/>

22
docs/reference/gio/gio-sections.txt
View File

@ -1804,10 +1804,6 @@ GTcpConnection
g_tcp_connection_set_graceful_disconnect
g_tcp_connection_get_graceful_disconnect
<SUBSECTION>
GUnixConnection
g_unix_connection_receive_fd
g_unix_connection_send_fd
<SUBSECTION>
g_socket_connection_factory_create_connection
g_socket_connection_factory_lookup_type
g_socket_connection_factory_register_type
@ -1826,6 +1822,20 @@ G_TCP_CONNECTION
G_TCP_CONNECTION_CLASS
G_TCP_CONNECTION_GET_CLASS
G_TYPE_TCP_CONNECTION
<SUBSECTION Private>
GSocketConnectionPrivate
g_socket_connection_get_type
GTcpConnectionPrivate
g_tcp_connection_get_type
</SECTION>
<SECTION>
<FILE>gunixconnection</FILE>
<TITLE>GUnixConnection</TITLE>
GUnixConnection
g_unix_connection_receive_fd
g_unix_connection_send_fd
<SECTION Standard>
GUnixConnectionClass
G_IS_UNIX_CONNECTION
G_IS_UNIX_CONNECTION_CLASS
@ -1834,10 +1844,6 @@ G_UNIX_CONNECTION
G_UNIX_CONNECTION_CLASS
G_UNIX_CONNECTION_GET_CLASS
<SUBSECTION Private>
GSocketConnectionPrivate
g_socket_connection_get_type
GTcpConnectionPrivate
g_tcp_connection_get_type
GUnixConnectionPrivate
g_unix_connection_get_type
</SECTION>

16
gio/gdesktopappinfo.c
View File

@ -48,19 +48,19 @@
/**
* SECTION:gdesktopappinfo
* @short_description: Application information from desktop files
* @include: gio/gdesktopappinfo.h
*
* @include: gio/gdesktopappinfo.h
*
* #GDesktopAppInfo is an implementation of #GAppInfo based on
* desktop files.
*
* Note that <filename>&lt;gio/gdesktopappinfo.h&gt;</filename> belongs to
* the UNIX-specific GIO interfaces, thus you have to use the
*
* Note that <filename>&lt;gio/gdesktopappinfo.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.
*/
#define DEFAULT_APPLICATIONS_GROUP "Default Applications"
#define ADDED_ASSOCIATIONS_GROUP "Added Associations"
#define REMOVED_ASSOCIATIONS_GROUP "Removed Associations"
#define DEFAULT_APPLICATIONS_GROUP "Default Applications"
#define ADDED_ASSOCIATIONS_GROUP "Added Associations"
#define REMOVED_ASSOCIATIONS_GROUP "Removed Associations"
#define MIME_CACHE_GROUP "MIME Cache"
#define FULL_NAME_KEY "X-GNOME-FullName"

6
gio/gfiledescriptorbased.c
View File

@ -29,12 +29,16 @@
/**
* SECTION:gfiledescriptorbased
* @short_description: Interface for file descriptor based IO
* @include: gio/gio.h
* @include: gio/gfiledescriptorbased.h
* @see_also: #GInputStream, #GOutputStream
*
* #GFileDescriptorBased is implemented by streams (implementations of
* #GInputStream or #GOutputStream) that are based on file descriptors.
*
* Note that <filename>&lt;gio/gfiledescriptorbased.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.
*
* Since: 2.24
*
**/

11
gio/gunixconnection.c
View File

@ -19,14 +19,19 @@
/**
* SECTION: gunixconnection
* @title: GUnixConnection
* @short_description: a Unix domain #GSocketConnection
* @short_description: A UNIX domain GSocketConnection
* @include: gio/gunixconnection.h
* @see_also: #GSocketConnection.
*
* This is the subclass of #GSocketConnection that is created
* for UNIX domain sockets.
*
* It contains functions to do some of the unix socket specific
* functionallity like passing file descriptors.
* It contains functions to do some of the UNIX socket specific
* functionality like passing file descriptors.
*
* Note that <filename>&lt;gio/gunixconnection.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.
*
* Since: 2.22
*/

7
gio/gunixfdlist.c
View File

@ -15,7 +15,8 @@
/**
* SECTION: gunixfdlist
* @title: GUnixFDList
* @short_description: An object containing a set of file descriptors
* @short_description: An object containing a set of UNIX file descriptors
* @include: gio/gunixfdlist.h
* @see_also: #GUnixFDMessage
*
* A #GUnixFDList contains a list of file descriptors. It owns the file
@ -24,6 +25,10 @@
* It may be wrapped in a #GUnixFDMessage and sent over a #GSocket in
* the %G_SOCKET_ADDRESS_UNIX family by using g_socket_send_message()
* and received using g_socket_receive_message().
*
* Note that <filename>&lt;gio/gunixfdlist.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.
*/
#define _GNU_SOURCE /* for F_DUPFD_CLOEXEC */

13
gio/gunixfdmessage.c
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"

4
gio/gunixinputstream.c
View File

@ -50,8 +50,8 @@
* UNIX file descriptor, including asynchronous operations. The file
* descriptor must be selectable, so it doesn't work with opened files.
*
* Note that <filename>&lt;gio/gunixinputstream.h&gt;</filename> belongs
* to the UNIX-specific GIO interfaces, thus you have to use the
* Note that <filename>&lt;gio/gunixinputstream.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.
*/

8
gio/gunixmounts.c
View File

@ -63,12 +63,12 @@ static const char *_resolve_dev_root (void);
/**
* SECTION:gunixmounts
* @include: gio/gunixmounts.h
* @short_description: Unix Mounts
*
* @short_description: UNIX mounts
*
* Routines for managing mounted UNIX mount points and paths.
*
* Note that <filename>&lt;gio/gunixmounts.h&gt;</filename> belongs to the
* UNIX-specific GIO interfaces, thus you have to use the
* Note that <filename>&lt;gio/gunixmounts.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.
*/

6
gio/gunixoutputstream.c
View File

@ -42,15 +42,15 @@
/**
* SECTION:gunixoutputstream
* @short_description: Streaming output operations for Unix file descriptors
* @short_description: Streaming output operations for UNIX file descriptors
* @include: gio/gunixoutputstream.h
* @see_also: #GOutputStream
*
* #GUnixOutputStream implements #GOutputStream for writing to a
* unix file descriptor, including asynchronous operations. The file
* UNIX file descriptor, including asynchronous operations. The file
* descriptor must be selectable, so it doesn't work with opened files.
*
* Note that <filename>&lt;gio/gunixoutputstream.h&gt;</filename> belongs
* Note that <filename>&lt;gio/gunixoutputstream.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.
*/

14
gio/gunixsocketaddress.c
View File

@ -34,18 +34,22 @@
/**
* SECTION:gunixsocketaddress
* @short_description: UNIX GSocketAddress
* @include: gio/gunixsocketaddress.h
*
* Support for UNIX-domain (aka local) sockets.
* Support for UNIX-domain (also known as local) sockets.
*
* Unix domain sockets are generally visible in the filesystem.
* UNIX domain sockets are generally visible in the filesystem.
* However, some systems support abstract socket names which are not
* visible in the filesystem and not affected by the filesystem
* permissions, visibility, etc. Currently this is only supported
* under Linux. If you attempt to use abstract sockets on other
* systems, function calls may return %G_IO_ERROR_NOT_SUPPORTED
* errors. You can use
* g_unix_socket_address_abstract_names_supported() to see if abstract
* names are supported.
* errors. You can use g_unix_socket_address_abstract_names_supported()
* to see if abstract names are supported.
*
* Note that <filename>&lt;gio/gunixsocketaddress.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.
*/
/**