luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-08-01 15:03:39 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: don't use the type tag

Browse Source 
Just avoid explicit docbook markup.
This commit is contained in:
Matthias Clasen
2014-01-31 05:58:17 -05:00
parent 3d42934b71
commit fc04275a00
8 changed files with 203 additions and 226 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
gio/gsocketaddress.c
View File

@@ -47,16 +47,15 @@
* for socket communication
* @include: gio/gio.h
*
* #GSocketAddress is the equivalent of <type>struct sockaddr</type>
* in the BSD sockets API. This is an abstract class; use
* #GInetSocketAddress for internet sockets, or #GUnixSocketAddress
* for UNIX domain sockets.
* #GSocketAddress is the equivalent of struct sockaddr in the BSD
* sockets API. This is an abstract class; use #GInetSocketAddress
* for internet sockets, or #GUnixSocketAddress for UNIX domain sockets.
*/
/**
* GSocketAddress:
*
* A socket endpoint address, corresponding to <type>struct sockaddr</type>
* A socket endpoint address, corresponding to struct sockaddr
* or one of its subtypes.
*/
@@ -80,7 +79,7 @@ G_DEFINE_ABSTRACT_TYPE_WITH_CODE (GSocketAddress, g_socket_address, G_TYPE_OBJEC
*
* Gets the socket family type of @address.
*
* Returns: the socket family type of @address.
* Returns: the socket family type of @address
*
* Since: 2.22
*/
@@ -143,11 +142,11 @@ g_socket_address_init (GSocketAddress *address)
* g_socket_address_get_native_size:
* @address: a #GSocketAddress
*
* Gets the size of @address's native <type>struct sockaddr</type>.
* Gets the size of @address's native struct sockaddr.
* You can use this to allocate memory to pass to
* g_socket_address_to_native().
*
* Returns: the size of the native <type>struct sockaddr</type> that
* Returns: the size of the native struct sockaddr that
* @address represents
*
* Since: 2.22
@@ -164,17 +163,16 @@ g_socket_address_get_native_size (GSocketAddress *address)
* g_socket_address_to_native:
* @address: a #GSocketAddress
* @dest: a pointer to a memory location that will contain the native
* <type>struct sockaddr</type>.
* struct sockaddr
* @destlen: the size of @dest. Must be at least as large as
* g_socket_address_get_native_size().
* @error: #GError for error reporting, or %NULL to ignore.
* g_socket_address_get_native_size()
* @error: #GError for error reporting, or %NULL to ignore
*
* Converts a #GSocketAddress to a native <type>struct
* sockaddr</type>, which can be passed to low-level functions like
* connect() or bind().
* Converts a #GSocketAddress to a native struct sockaddr, which can
* be passed to low-level functions like connect() or bind().
*
* If not enough space is available, a %G_IO_ERROR_NO_SPACE error is
* returned. If the address type is not known on the system
* If not enough space is available, a %G_IO_ERROR_NO_SPACE error
* is returned. If the address type is not known on the system
* then a %G_IO_ERROR_NOT_SUPPORTED error is returned.
*
* Returns: %TRUE if @dest was filled in, %FALSE on error
@@ -194,14 +192,14 @@ g_socket_address_to_native (GSocketAddress *address,
/**
* g_socket_address_new_from_native:
* @native: a pointer to a <type>struct sockaddr</type>
* @native: a pointer to a struct sockaddr
* @len: the size of the memory location pointed to by @native
*
* Creates a #GSocketAddress subclass corresponding to the native
* <type>struct sockaddr</type> @native.
* struct sockaddr @native.
*
* Returns: a new #GSocketAddress if @native could successfully be converted,
* otherwise %NULL.
* Returns: a new #GSocketAddress if @native could successfully
* be converted, otherwise %NULL
*
* Since: 2.22
*/