Commit fc04275a authored by Matthias Clasen's avatar Matthias Clasen

Docs: don't use the type tag

Just avoid explicit docbook markup.
parent 3d42934b
......@@ -53,21 +53,19 @@
* #GUnixCredentialsMessage, g_unix_connection_send_credentials() and
* g_unix_connection_receive_credentials() for details.
*
* On Linux, the native credential type is a <type>struct ucred</type>
* - see the
* <citerefentry><refentrytitle>unix</refentrytitle><manvolnum>7</manvolnum></citerefentry>
* man page for details. This corresponds to
* On Linux, the native credential type is a struct ucred - see the
* unix(7) man page for details. This corresponds to
* %G_CREDENTIALS_TYPE_LINUX_UCRED.
*
* On FreeBSD, Debian GNU/kFreeBSD, and GNU/Hurd, the native
* credential type is a <type>struct cmsgcred</type>. This corresponds
* credential type is a struct cmsgcred. This corresponds
* to %G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED.
*
* On OpenBSD, the native credential type is a <type>struct sockpeercred</type>.
* On OpenBSD, the native credential type is a struct sockpeercred.
* This corresponds to %G_CREDENTIALS_TYPE_OPENBSD_SOCKPEERCRED.
*
* On Solaris (including OpenSolaris and its derivatives), the native
* credential type is a <type>ucred_t</type>. This corresponds to
* credential type is a ucred_t. This corresponds to
* %G_CREDENTIALS_TYPE_SOLARIS_UCRED.
*/
......
......@@ -44,8 +44,8 @@
/**
* GInetSocketAddress:
*
* An IPv4 or IPv6 socket address, corresponding to a <type>struct
* sockaddr_in</type> or <type>struct sockaddr_in6</type>.
* An IPv4 or IPv6 socket address, corresponding to a struct
* sockaddr_in or struct sockaddr_in6.
*/
struct _GInetSocketAddressPrivate
......
......@@ -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
*/
......
......@@ -55,7 +55,7 @@
* GUnixSocketAddress:
*
* A UNIX-domain (local) socket address, corresponding to a
* <type>struct sockaddr_un</type>.
* struct sockaddr_un.
*/
enum
......
......@@ -64,8 +64,7 @@
* gpointer:
*
* An untyped pointer.
* #gpointer looks better and is easier to use
* than <type>void*</type>.
* #gpointer looks better and is easier to use than void*.
*/
/**
......@@ -81,19 +80,19 @@
/**
* gchar:
*
* Corresponds to the standard C <type>char</type> type.
* Corresponds to the standard C char type.
*/
/**
* guchar:
*
* Corresponds to the standard C <type>unsigned char</type> type.
* Corresponds to the standard C unsigned char type.
*/
/**
* gint:
*
* Corresponds to the standard C <type>int</type> type.
* Corresponds to the standard C int type.
* Values of this type can range from #G_MININT to #G_MAXINT.
*/
......@@ -112,7 +111,7 @@
/**
* guint:
*
* Corresponds to the standard C <type>unsigned int</type> type.
* Corresponds to the standard C unsigned int type.
* Values of this type can range from 0 to #G_MAXUINT.
*/
......@@ -125,7 +124,7 @@
/**
* gshort:
*
* Corresponds to the standard C <type>short</type> type.
* Corresponds to the standard C short type.
* Values of this type can range from #G_MINSHORT to #G_MAXSHORT.
*/
......@@ -144,7 +143,7 @@
/**
* gushort:
*
* Corresponds to the standard C <type>unsigned short</type> type.
* Corresponds to the standard C unsigned short type.
* Values of this type can range from 0 to #G_MAXUSHORT.
*/
......@@ -157,7 +156,7 @@
/**
* glong:
*
* Corresponds to the standard C <type>long</type> type.
* Corresponds to the standard C long type.
* Values of this type can range from #G_MINLONG to #G_MAXLONG.
*/
......@@ -176,7 +175,7 @@
/**
* gulong:
*
* Corresponds to the standard C <type>unsigned long</type> type.
* Corresponds to the standard C unsigned long type.
* Values of this type can range from 0 to #G_MAXULONG.
*/
......@@ -491,7 +490,7 @@
/**
* gfloat:
*
* Corresponds to the standard C <type>float</type> type.
* Corresponds to the standard C float type.
* Values of this type can range from -#G_MAXFLOAT to #G_MAXFLOAT.
*/
......@@ -513,7 +512,7 @@
/**
* gdouble:
*
* Corresponds to the standard C <type>double</type> type.
* Corresponds to the standard C double type.
* Values of this type can range from -#G_MAXDOUBLE to #G_MAXDOUBLE.
*/
......@@ -536,7 +535,7 @@
* gsize:
*
* An unsigned integer type of the result of the sizeof operator,
* corresponding to the <type>size_t</type> type defined in C99.
* corresponding to the size_t type defined in C99.
* This type is wide enough to hold the numeric value of a pointer,
* so it is usually 32bit wide on a 32bit platform and 64bit wide
* on a 64bit platform. Values of this type can range from 0 to
......@@ -577,7 +576,7 @@
* gssize:
*
* A signed variant of #gsize, corresponding to the
* <type>ssize_t</type> defined on most platforms.
* ssize_t defined on most platforms.
* Values of this type can range from #G_MINSSIZE
* to #G_MAXSSIZE.
*
......@@ -614,7 +613,7 @@
* goffset:
*
* A signed integer type that is used for file offsets,
* corresponding to the C99 type <type>off64_t</type>.
* corresponding to the C99 type off64_t.
* Values of this type can range from #G_MINOFFSET to
* #G_MAXOFFSET.
*
......@@ -670,7 +669,7 @@
/**
* gintptr:
*
* Corresponds to the C99 type <type>intptr_t</type>,
* Corresponds to the C99 type intptr_t,
* a signed integer type that can hold any pointer.
*
* To print or scan values of this type, use
......@@ -701,7 +700,7 @@
/**
* guintptr:
*
* Corresponds to the C99 type <type>uintptr_t</type>,
* Corresponds to the C99 type uintptr_t,
* an unsigned integer type that can hold any pointer.
*
* To print or scan values of this type, use
......@@ -1772,15 +1771,14 @@
/**
* G_VA_COPY:
* @ap1: the <type>va_list</type> variable to place a copy of @ap2 in
* @ap2: a <type>va_list</type>
* @ap1: the va_list variable to place a copy of @ap2 in
* @ap2: a va_list
*
* Portable way to copy <type>va_list</type> variables.
* Portable way to copy va_list variables.
*
* In order to use this function, you must include
* <filename>string.h</filename> yourself, because this macro may
* use memmove() and GLib does not include <filename>string.h</filename>
* for you.
* In order to use this function, you must include string.h yourself,
* because this macro may use memmove() and GLib does not include
* string.h for you.
*/
/**
......
......@@ -1281,7 +1281,7 @@ g_date_set_parse (GDate *d,
/**
* g_date_set_time_t:
* @date: a #GDate
* @timet: <type>time_t</type> value to set
* @timet: time_t value to set
*
* Sets the value of a date to the date corresponding to a time
* specified as a time_t. The time to date conversion is done using
......
......@@ -99,9 +99,9 @@
* Unlike the standard C library isalnum() function, this only
* recognizes standard ASCII letters and ignores the locale,
* returning %FALSE for all non-ASCII characters. Also, unlike
* the standard library function, this takes a <type>char</type>,
* not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need to
* cast to #guchar before passing a possibly non-ASCII character in.
* the standard library function, this takes a char, not an int,
* so don't call it on %EOF, but no need to cast to #guchar before
* passing a possibly non-ASCII character in.
*
* Returns: %TRUE if @c is an ASCII alphanumeric character
*/
......@@ -115,9 +115,9 @@
* Unlike the standard C library isalpha() function, this only
* recognizes standard ASCII letters and ignores the locale,
* returning %FALSE for all non-ASCII characters. Also, unlike
* the standard library function, this takes a <type>char</type>,
* not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need to
* cast to #guchar before passing a possibly non-ASCII character in.
* the standard library function, this takes a char, not an int,
* so don't call it on %EOF, but no need to cast to #guchar before
* passing a possibly non-ASCII character in.
*
* Returns: %TRUE if @c is an ASCII alphabetic character
*/
......@@ -131,9 +131,9 @@
* Unlike the standard C library iscntrl() function, this only
* recognizes standard ASCII control characters and ignores the
* locale, returning %FALSE for all non-ASCII characters. Also,
* unlike the standard library function, this takes a <type>char</type>,
* not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need to
* cast to #guchar before passing a possibly non-ASCII character in.
* unlike the standard library function, this takes a char, not
* an int, so don't call it on %EOF, but no need to cast to #guchar
* before passing a possibly non-ASCII character in.
*
* Returns: %TRUE if @c is an ASCII control character.
*/
......@@ -145,9 +145,8 @@
* Determines whether a character is digit (0-9).
*
* Unlike the standard C library isdigit() function, this takes
* a <type>char</type>, not an <type>int</type>, so don't call it
* on <literal>EOF</literal>, but no need to cast to #guchar before passing a possibly
* non-ASCII character in.
* a char, not an int, so don't call it on %EOF, but no need to
* cast to #guchar before passing a possibly non-ASCII character in.
*
* Returns: %TRUE if @c is an ASCII digit.
*/
......@@ -161,9 +160,9 @@
* Unlike the standard C library isgraph() function, this only
* recognizes standard ASCII characters and ignores the locale,
* returning %FALSE for all non-ASCII characters. Also, unlike
* the standard library function, this takes a <type>char</type>,
* not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need
* to cast to #guchar before passing a possibly non-ASCII character in.
* the standard library function, this takes a char, not an int,
* so don't call it on %EOF, but no need to cast to #guchar before
* passing a possibly non-ASCII character in.
*
* Returns: %TRUE if @c is an ASCII printing character other than space.
*/
......@@ -177,10 +176,9 @@
* Unlike the standard C library islower() function, this only
* recognizes standard ASCII letters and ignores the locale,
* returning %FALSE for all non-ASCII characters. Also, unlike
* the standard library function, this takes a <type>char</type>,
* not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need
* to worry about casting to #guchar before passing a possibly
* non-ASCII character in.
* the standard library function, this takes a char, not an int,
* so don't call it on %EOF, but no need to worry about casting
* to #guchar before passing a possibly non-ASCII character in.
*
* Returns: %TRUE if @c is an ASCII lower case letter
*/
......@@ -194,9 +192,9 @@
* Unlike the standard C library isprint() function, this only
* recognizes standard ASCII characters and ignores the locale,
* returning %FALSE for all non-ASCII characters. Also, unlike
* the standard library function, this takes a <type>char</type>,
* not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need
* to cast to #guchar before passing a possibly non-ASCII character in.
* the standard library function, this takes a char, not an int,
* so don't call it on %EOF, but no need to cast to #guchar before
* passing a possibly non-ASCII character in.
*
* Returns: %TRUE if @c is an ASCII printing character.
*/
......@@ -210,9 +208,9 @@
* Unlike the standard C library ispunct() function, this only
* recognizes standard ASCII letters and ignores the locale,
* returning %FALSE for all non-ASCII characters. Also, unlike
* the standard library function, this takes a <type>char</type>,
* not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need to
* cast to #guchar before passing a possibly non-ASCII character in.
* the standard library function, this takes a char, not an int,
* so don't call it on %EOF, but no need to cast to #guchar before
* passing a possibly non-ASCII character in.
*
* Returns: %TRUE if @c is an ASCII punctuation character.
*/
......@@ -226,9 +224,9 @@
* Unlike the standard C library isspace() function, this only
* recognizes standard ASCII white-space and ignores the locale,
* returning %FALSE for all non-ASCII characters. Also, unlike
* the standard library function, this takes a <type>char</type>,
* not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need to
* cast to #guchar before passing a possibly non-ASCII character in.
* the standard library function, this takes a char, not an int,
* so don't call it on %EOF, but no need to cast to #guchar before
* passing a possibly non-ASCII character in.
*
* Returns: %TRUE if @c is an ASCII white-space character
*/
......@@ -242,10 +240,9 @@
* Unlike the standard C library isupper() function, this only
* recognizes standard ASCII letters and ignores the locale,
* returning %FALSE for all non-ASCII characters. Also, unlike
* the standard library function, this takes a <type>char</type>,
* not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need to
* worry about casting to #guchar before passing a possibly non-ASCII
* character in.
* the standard library function, this takes a char, not an int,
* so don't call it on %EOF, but no need to worry about casting
* to #guchar before passing a possibly non-ASCII character in.
*
* Returns: %TRUE if @c is an ASCII upper case letter
*/
......@@ -257,9 +254,8 @@
* Determines whether a character is a hexadecimal-digit character.
*
* Unlike the standard C library isxdigit() function, this takes
* a <type>char</type>, not an <type>int</type>, so don't call it
* on <literal>EOF</literal>, but no need to cast to #guchar before passing a
* possibly non-ASCII character in.
* a char, not an int, so don't call it on %EOF, but no need to
* cast to #guchar before passing a possibly non-ASCII character in.
*
* Returns: %TRUE if @c is an ASCII hexadecimal-digit character.
*/
......
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment