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

docs: Move the GUnixSocketAddress SECTION

Browse Source 
Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
This commit is contained in:
Philip Withnall 2023-11-02 16:27:32 +00:00
parent 1390713af9
commit 830db4e3c0
1 changed files with 6 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
gio/gunixsocketaddress.c
View File

@ -35,22 +35,21 @@
#endif #endif
/** /**
* SECTION:gunixsocketaddress * GUnixSocketAddress:
* @short_description: UNIX GSocketAddress
* @include: gio/gunixsocketaddress.h
* *
* Support for UNIX-domain (also known as local) sockets. * Support for UNIX-domain (also known as local) sockets, corresponding to
* `struct sockaddr_un`.
* *
* 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 * However, some systems support abstract socket names which are not
* visible in the filesystem and not affected by the filesystem * visible in the filesystem and not affected by the filesystem
* permissions, visibility, etc. Currently this is only supported * permissions, visibility, etc. Currently this is only supported
* under Linux. If you attempt to use abstract sockets on other * under Linux. If you attempt to use abstract sockets on other
* systems, function calls may return %G_IO_ERROR_NOT_SUPPORTED * systems, function calls may return `G_IO_ERROR_NOT_SUPPORTED`
* errors. You can use g_unix_socket_address_abstract_names_supported() * errors. You can use [func@Gio.UnixSocketAddress.abstract_names_supported]
* to see if abstract names are supported. * to see if abstract names are supported.
* *
* Since GLib 2.72, #GUnixSocketAddress is available on all platforms. It * Since GLib 2.72, `GUnixSocketAddress` is available on all platforms. It
* requires underlying system support (such as Windows 10 with `AF_UNIX`) at * requires underlying system support (such as Windows 10 with `AF_UNIX`) at
* run time. * run time.
* *
@ -59,13 +58,6 @@
* when using it. This is no longer necessary since GLib 2.72. * when using it. This is no longer necessary since GLib 2.72.
*/ */
/**
* GUnixSocketAddress:
*
* A UNIX-domain (local) socket address, corresponding to a
* struct sockaddr_un.
*/
enum enum
{ {
PROP_0, PROP_0,